https://github.com/openclimatefix/ocf-template
Template Repository for OCF Projects
https://github.com/openclimatefix/ocf-template
Last synced: about 1 year ago
JSON representation
Template Repository for OCF Projects
- Host: GitHub
- URL: https://github.com/openclimatefix/ocf-template
- Owner: openclimatefix
- Created: 2023-03-02T16:21:54.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-11T15:44:28.000Z (about 1 year ago)
- Last Synced: 2025-03-24T10:11:05.261Z (about 1 year ago)
- Language: Python
- Size: 62.5 KB
- Stars: 4
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OCF Template
**Starting point for OCF projects**
[](https://github.com/openclimatefix/ocf-template/actions/workflows/ci.yml)
[](https://github.com/openclimatefix/ocf-template/tags)
[](https://pypi.org/project/ocf-template)
[](https://openclimatefix.github.io/ocf-template/)
[](https://github.com/openclimatefix/ocf-template/graphs/contributors)
[](https://github.com/openclimatefix#how-easy-is-it-to-get-involved)
[](https://github.com/openclimatefix#how-easy-is-it-to-get-involved)
[](https://github.com/openclimatefix#how-easy-is-it-to-get-involved)
This section of the README should contain a brief description of the project.
Perhaps give a short amount of context around why it exists; the problem it solves.
By the end of reading this short paragraph, a contributor should not be confused
as to the purpose of the repository and its role in the organisation.
They might even have an idea of how it could be useful to them!
> [!Note]
> Any important callouts (informing visitors this repository is in early
> design stages, or not for general use, or requires a lot of prerequisite
> knowledge or infrastructure) should be placed in a note like this.
> Like: This repository does not hold template workflows, contributing
> guides, etc - head to
> [OCF's .github repository](https://github.com/openclimatefix/.github)
> for those.
## Installation
How to install the project for *general use* (**not** for development), so:
"`pip install x`", or: "pull the latest checkpoint from `y`";
**not**: "clone the repo and run `make install`".
For example, to "install" this template as the basis of a new repository,
do the following:
1. Click **Use this template** (in green) above the upper right of this file
2. Select **Create a new repository**
3. Create the new repository as desired
## Example usage
One or two short examples of using the project to solve a problem.
Quick happy-path examples that show the project in action or outline a
common use case.
> [!Note]
> If the project does not have a clear usage pattern, consider informing the
> user as such in the first callout. Then you can skip *Installation* and
> *Example usage* - perhaps replacing them with a *Quickstart* section -
> or just moving straight on to *Development*.
Once you have installed the project into a new GitHub repository,
`git clone` it and `cd` into the created directory.
**For a Python project:**
1. Modify the `pyproject.toml` file, updating the name, description, authors,
and dependencies as needed.
2. Update the name of the package from `ocf_template` to your package name.
3. Install the project in editable mode (in a new virtual environment!)
with `pip install -e .`.
Also, importantly, update this README!
**For other projects:**
Simply delete `src` and `pyproject.toml`, and just use and update the README
part of the template as required.
When your project is up and running, add any relevant workflows from OCF's
template workflows or otherwise. See
[Choosing and using a workflow template](https://docs.github.com/en/actions/writing-workflows/using-workflow-templates#choosing-and-using-a-workflow-template)
for more details.
*For more information, head to the [Documentation](#documentation).*
## Documentation
Link to the project's documentation, if it exists. Also consider internal
linking to parts of interest of the documentation, such as **Development**,
**API**, **Configuration** and so on.
## FAQ
Any major points from github discussions, or highlights from the documentation.
If the same question is often asked, answer it in here!
### Can I leave this section out?
Yes, this is an optional section.
### Is "How do I run the application" a valid FAQ question?
No, that should be in example usage!
### How should I format the FAQ section?
Like this! Questions in level three headings, answers in plain text.
## Development
Anything specific to getting set up for development on the project: required libraries,
infrastructure, extra tools that may be desired ([MyPy](https://mypy.readthedocs.io/en/stable/),
[pre-commit](https://pre-commit.com/), etc). Also, how to run tests!
Make sure you have the most up to date drivers for your 32 GPU array to use this template!
> [!Note]
> The development section might be contained within the documentation, in which case
> remove the *Development* section, and instead specify links to the relevant parts
> of the documentation in the *Documentation* section.
### Running the test suite
The couple of commands, and perhaps additional dependencies, to run the test suite of
the application or service.
## Contributing and community
[](https://github.com/openclimatefix/ocf-template/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc)
- PR's are welcome! See the [Organisation Profile](https://github.com/openclimatefix) for details on contributing
- Find out about our other projects in the [here](https://github.com/openclimatefix/.github/tree/main/profile)
- Check out the [OCF blog](https://openclimatefix.org/blog) for updates
- Follow OCF on [LinkedIn](https://uk.linkedin.com/company/open-climate-fix)
## Contributors
---
*Part of the [Open Climate Fix](https://github.com/orgs/openclimatefix/people) community.*
[](https://openclimatefix.org)