/modellingteam-template

Template for the Modelling Team

MIT LicenseMIT

status: experimental


{PROJECT NAME}

Modelling Team, Data & Analytics (D&A)

This project is in development, and should not be relied upon. Please do not use any code without consultation of Modelling Team (D&A). Be aware that whilst a significant part of the code has been quality assured, there remain large elements of the codebase which have not yet been.
Report Bug Request Feature

Table of Contents
  1. About the project
  2. Usage
  3. Contributing
  4. License

About the Project

This repository holds code for the {PROJECT NAME} {SHORT DESCRIPTION}

Link to any external reference sources/publications

Note: Only public or fake data are shared in this repository.

Project Stucture

  • The main code is found in the root of the repository (see Usage below for more information)
  • The accompanying report is also available in the reports folder
  • More information about the code usage can be found in the model card
  • {OTHER REPO STRUCTURE}

Built With

Python v3.9

  • {LIST OF MAIN PACKAGE VERSIONS}

Datasets

{DESCRIPTION AND LINKS TO DATASETS}

{LINK TO FAKE DATA TO SUPPORT INITAIL CODE RUNS}

(back to top)

Usage

{DESCRIPTION OF CODE}

Outputs

{LIST AND DESCRIPTION OF OUTPUTS}

{NOTES ON REPRODUCIBILITY OF RESULTS}

Roadmap

See the {LINK TO REPO ISSUES} for a list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

See CONTRIBUTING.md for detailed guidance.

Contact

To access the Unified Data Access Layer (UDAL), please contact to our Service Desk with the request form on FutureNHS

(back to top)

License

Unless stated otherwise, the codebase is released under the MIT Licence. This covers both the codebase and any sample code in the documentation.

See LICENSE for more information.

The documentation is © Crown copyright and available under the terms of the Open Government 3.0 licence.

(back to top)