{"id":20200859,"url":"https://github.com/openclimatefix/ocf-template","last_synced_at":"2025-04-10T11:21:42.352Z","repository":{"id":99304388,"uuid":"608735306","full_name":"openclimatefix/ocf-template","owner":"openclimatefix","description":"Template Repository for OCF Projects","archived":false,"fork":false,"pushed_at":"2025-03-11T15:44:28.000Z","size":64,"stargazers_count":4,"open_issues_count":4,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-24T10:11:05.261Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openclimatefix.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["openclimatefix"],"patreon":null,"open_collective":"openclimatefix","ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":null}},"created_at":"2023-03-02T16:21:54.000Z","updated_at":"2025-03-11T15:44:31.000Z","dependencies_parsed_at":null,"dependency_job_id":"8a12dd08-b937-4b81-b68a-e236a9e9547a","html_url":"https://github.com/openclimatefix/ocf-template","commit_stats":{"total_commits":24,"total_committers":4,"mean_commits":6.0,"dds":"0.41666666666666663","last_synced_commit":"9ec9ab7be8b8a531daead0be3d630ae8ac16b375"},"previous_names":[],"tags_count":7,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openclimatefix%2Focf-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openclimatefix%2Focf-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openclimatefix%2Focf-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openclimatefix%2Focf-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openclimatefix","download_url":"https://codeload.github.com/openclimatefix/ocf-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248208603,"owners_count":21065203,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-14T04:45:53.718Z","updated_at":"2025-04-10T11:21:42.326Z","avatar_url":"https://github.com/openclimatefix.png","language":"Python","funding_links":["https://github.com/sponsors/openclimatefix","https://opencollective.com/openclimatefix"],"categories":[],"sub_categories":[],"readme":"# OCF Template\n\n**Starting point for OCF projects**\n \n[![workflows badge](https://img.shields.io/github/actions/workflow/status/openclimatefix/ocf-template/ci.yml?branch=maine\u0026color=FFD053\u0026label=workflow)](https://github.com/openclimatefix/ocf-template/actions/workflows/ci.yml)\n[![tags badge](https://img.shields.io/github/v/tag/openclimatefix/ocf-template?include_prereleases\u0026sort=semver\u0026color=FFAC5F)](https://github.com/openclimatefix/ocf-template/tags)\n[![pypi badge](https://img.shields.io/pypi/v/ocf-template?\u0026color=07BCDF)](https://pypi.org/project/ocf-template)\n[![documentation badge](https://img.shields.io/badge/docs-latest-086788)](https://openclimatefix.github.io/ocf-template/)\n[![contributors badge](https://img.shields.io/github/contributors/openclimatefix/ocf-template?color=FFFFFF)](https://github.com/openclimatefix/ocf-template/graphs/contributors)\n[![ease of contribution: easy](https://img.shields.io/badge/ease%20of%20contribution:%20easy-32bd50)](https://github.com/openclimatefix#how-easy-is-it-to-get-involved) \n[![ease of contribution: medium](https://img.shields.io/badge/ease%20of%20contribution:%20medium-f4900c)](https://github.com/openclimatefix#how-easy-is-it-to-get-involved)\n[![ease of contribution: hard](https://img.shields.io/badge/ease%20of%20contribution:%20hard-bb2629)](https://github.com/openclimatefix#how-easy-is-it-to-get-involved)\n\nThis section of the README should contain a brief description of the project.\nPerhaps give a short amount of context around why it exists; the problem it solves.\nBy the end of reading this short paragraph, a contributor should not be confused\nas to the purpose of the repository and its role in the organisation.\n\nThey might even have an idea of how it could be useful to them!\n\n\u003e [!Note]\n\u003e Any important callouts (informing visitors this repository is in early\n\u003e design stages, or not for general use, or requires a lot of prerequisite\n\u003e knowledge or infrastructure) should be placed in a note like this.\n\u003e Like: This repository does not hold template workflows, contributing\n\u003e guides, etc - head to\n\u003e [OCF's .github repository](https://github.com/openclimatefix/.github)\n\u003e for those.\n\n\n## Installation\n\nHow to install the project for *general use* (**not** for development), so:\n\"`pip install x`\", or: \"pull the latest checkpoint from `y`\";\n**not**: \"clone the repo and run `make install`\".\nFor example, to \"install\" this template as the basis of a new repository,\ndo the following:\n\n1. Click **Use this template** (in green) above the upper right of this file\n2. Select **Create a new repository**\n3. Create the new repository as desired\n\n\n## Example usage\n\nOne or two short examples of using the project to solve a problem.\nQuick happy-path examples that show the project in action or outline a\ncommon use case.\n\n\u003e [!Note]\n\u003e If the project does not have a clear usage pattern, consider informing the\n\u003e user as such in the first callout. Then you can skip *Installation* and\n\u003e *Example usage* - perhaps replacing them with a *Quickstart* section -\n\u003e or just moving straight on to *Development*.\n\nOnce you have installed the project into a new GitHub repository,\n`git clone` it and `cd` into the created directory.\n\n**For a Python project:**\n\n1. Modify the `pyproject.toml` file, updating the name, description, authors,\nand dependencies as needed.\n2. Update the name of the package from `ocf_template` to your package name.\n3. Install the project in editable mode (in a new virtual environment!)\nwith `pip install -e .`.\n\nAlso, importantly, update this README!\n\n**For other projects:**\n\nSimply delete `src` and `pyproject.toml`, and just use and update the README\npart of the template as required.\n\n\nWhen your project is up and running, add any relevant workflows from OCF's\ntemplate workflows or otherwise. See\n[Choosing and using a workflow template](https://docs.github.com/en/actions/writing-workflows/using-workflow-templates#choosing-and-using-a-workflow-template)\nfor more details.\n\n*For more information, head to the [Documentation](#documentation).*\n\n\n## Documentation\n\nLink to the project's documentation, if it exists. Also consider internal\nlinking to parts of interest of the documentation, such as **Development**,\n**API**, **Configuration** and so on.\n\n\n## FAQ\n\nAny major points from github discussions, or highlights from the documentation.\nIf the same question is often asked, answer it in here!\n\n### Can I leave this section out?\n\nYes, this is an optional section.\n\n### Is \"How do I run the application\" a valid FAQ question?\n\nNo, that should be in example usage!\n\n### How should I format the FAQ section?\n\nLike this! Questions in level three headings, answers in plain text.\n\n\n## Development\n\nAnything specific to getting set up for development on the project: required libraries,\ninfrastructure, extra tools that may be desired ([MyPy](https://mypy.readthedocs.io/en/stable/),\n[pre-commit](https://pre-commit.com/), etc). Also, how to run tests!\n\nMake sure you have the most up to date drivers for your 32 GPU array to use this template! \n\n\u003e [!Note]\n\u003e The development section might be contained within the documentation, in which case\n\u003e remove the *Development* section, and instead specify links to the relevant parts\n\u003e of the documentation in the *Documentation* section.\n\n### Running the test suite\n\nThe couple of commands, and perhaps additional dependencies, to run the test suite of\nthe application or service. \n \n\n## Contributing and community\n\n[![issues badge](https://img.shields.io/github/issues/openclimatefix/ocf-template?color=FFAC5F)](https://github.com/openclimatefix/ocf-template/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)\n\n- PR's are welcome! See the [Organisation Profile](https://github.com/openclimatefix) for details on contributing\n- Find out about our other projects in the [here](https://github.com/openclimatefix/.github/tree/main/profile)\n- Check out the [OCF blog](https://openclimatefix.org/blog) for updates\n- Follow OCF on [LinkedIn](https://uk.linkedin.com/company/open-climate-fix)\n\n\n## Contributors\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --\u003e\n\u003c!-- prettier-ignore-start --\u003e\n\u003c!-- markdownlint-disable --\u003e\n\n\u003c!-- markdownlint-restore --\u003e\n\u003c!-- prettier-ignore-end --\u003e\n\n\u003c!-- ALL-CONTRIBUTORS-LIST:END --\u003e\n\n---\n\n*Part of the [Open Climate Fix](https://github.com/orgs/openclimatefix/people) community.*\n\n[![OCF Logo](https://cdn.prod.website-files.com/62d92550f6774db58d441cca/6324a2038936ecda71599a8b_OCF_Logo_black_trans.png)](https://openclimatefix.org)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenclimatefix%2Focf-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenclimatefix%2Focf-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenclimatefix%2Focf-template/lists"}