| Name | cstar-ocean JSON |
| Version |
0.0.0
JSON |
| download |
| home_page | None |
| Summary | Computational systems for tracking ocean carbon |
| upload_time | 2024-12-09 21:47:26 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | Apache-2.0 |
| keywords |
mcdr
cdr
ocean carbon
climate
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](https://codecov.io/gh/CWorthy-ocean/C-Star)
[](https://c-star.readthedocs.io/en/latest/?badge=latest)
> [!Warning]
> **This project is still in an early phase of development.**
>
> The [python API](https://c-star.readthedocs.io/en/latest/api.html) is not yet stable, and some aspects of the schema for the [blueprint](https://c-star.readthedocs.io/en/latest/terminology.html#term-blueprint) will likely evolve.
> Therefore whilst you are welcome to try out using the package, we cannot yet guarantee backwards compatibility.
We expect to reach a more stable version in Q1 2025.
>
> To see which systems C-Star has been tested on so far, see [Supported Systems](https://c-star.readthedocs.io/en/latest/machines.html).
# Installation
## Installation from GitHub
To obtain the latest development version, clone [this repository](https://github.com/CWorthy-ocean/C-Star):
```
git clone https://github.com/CWorthy-ocean/C-Star.git
cd C-Star
```
Next, install **one** of the following conda environments, depending on whether you are working on a supported HPC system (environment management by Linux Environment Modules) or a generic machine like a laptop (environment managed by conda):
```
conda env create -f ci/environment_hpc.yml # conda environment for supported HPC system
# conda env create -f ci/environment.yml # conda environment for generic machine
```
Activate the conda environment:
```
conda activate cstar_env
```
Finally, install `C-Star` in the same environment:
```
pip install -e .
```
## Run the tests
Before running the tests, you can activate the conda environment created in the previous section:
```
conda activate cstar_env
```
Check the installation of `C-Star` has worked by running the test suite
```
cd C-Star
pytest
```
# Getting Started
To learn how to use `C-Star`, check out the [documentation](https://c-star.readthedocs.io/en/latest/index.html).
# Feedback and contributions
If you find a bug, have a feature suggestion, or any other kind of feedback, please start a Discussion.
We also accept contributions in the form of Pull Requests.
## License
C-Star is openly available for use and permissively licenced under Apache 2.0.
Copyright 2024 [C]Worthy LLC.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Raw data
{
"_id": null,
"home_page": null,
"name": "cstar-ocean",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "MCDR, CDR, ocean carbon, climate",
"author": null,
"author_email": "Dafydd Stephenson <dafydd@cworthy.org>, Thomas Nicholas <tom@cworthy.org>, Nora Loose <nora@cworthy.org>, Matt Long <matt@cworthy.org>",
"download_url": "https://files.pythonhosted.org/packages/e2/63/e50e606fc012ae994f28eb5c99d981378a840fd68ceca4c692cd4c605852/cstar_ocean-0.0.0.tar.gz",
"platform": null,
"description": "[](https://codecov.io/gh/CWorthy-ocean/C-Star)\n[](https://c-star.readthedocs.io/en/latest/?badge=latest)\n\n> [!Warning] \n> **This project is still in an early phase of development.**\n>\n> The [python API](https://c-star.readthedocs.io/en/latest/api.html) is not yet stable, and some aspects of the schema for the [blueprint](https://c-star.readthedocs.io/en/latest/terminology.html#term-blueprint) will likely evolve. \n> Therefore whilst you are welcome to try out using the package, we cannot yet guarantee backwards compatibility. \nWe expect to reach a more stable version in Q1 2025.\n>\n> To see which systems C-Star has been tested on so far, see [Supported Systems](https://c-star.readthedocs.io/en/latest/machines.html).\n\n# Installation\n\n## Installation from GitHub\n\nTo obtain the latest development version, clone [this repository](https://github.com/CWorthy-ocean/C-Star):\n\n```\ngit clone https://github.com/CWorthy-ocean/C-Star.git\ncd C-Star\n``` \n\nNext, install **one** of the following conda environments, depending on whether you are working on a supported HPC system (environment management by Linux Environment Modules) or a generic machine like a laptop (environment managed by conda):\n\n```\nconda env create -f ci/environment_hpc.yml # conda environment for supported HPC system\n# conda env create -f ci/environment.yml # conda environment for generic machine \n```\n\nActivate the conda environment:\n```\nconda activate cstar_env\n```\n\nFinally, install `C-Star` in the same environment:\n```\npip install -e .\n``` \n\n## Run the tests\n\nBefore running the tests, you can activate the conda environment created in the previous section:\n```\nconda activate cstar_env\n```\n\nCheck the installation of `C-Star` has worked by running the test suite\n```\ncd C-Star\npytest\n```\n\n# Getting Started\n\nTo learn how to use `C-Star`, check out the [documentation](https://c-star.readthedocs.io/en/latest/index.html).\n\n# Feedback and contributions\n\nIf you find a bug, have a feature suggestion, or any other kind of feedback, please start a Discussion.\n\nWe also accept contributions in the form of Pull Requests.\n\n## License\n\nC-Star is openly available for use and permissively licenced under Apache 2.0. \n\n Copyright 2024 [C]Worthy LLC.\n\n Licensed under the Apache License, Version 2.0 (the \"License\");\n you may not use this file except in compliance with the License.\n You may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\n Unless required by applicable law or agreed to in writing, software\n distributed under the License is distributed on an \"AS IS\" BASIS,\n WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n See the License for the specific language governing permissions and\n limitations under the License.\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Computational systems for tracking ocean carbon",
"version": "0.0.0",
"project_urls": {
"homepage": "https://www.cworthy.org",
"repository": "https://github.com/CWorthy-ocean/C-Star"
},
"split_keywords": [
"mcdr",
" cdr",
" ocean carbon",
" climate"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ba10faaf0c9a142106144e27bfda199f83d41e8944851d8b80adc05910929c22",
"md5": "f97213fb48549b09ba8f3f87db29df87",
"sha256": "f0faf61638e31ec484c6a33bf2d20c9d96b78680d937a815a2cfb578363024b5"
},
"downloads": -1,
"filename": "cstar_ocean-0.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f97213fb48549b09ba8f3f87db29df87",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 102460,
"upload_time": "2024-12-09T21:47:24",
"upload_time_iso_8601": "2024-12-09T21:47:24.391984Z",
"url": "https://files.pythonhosted.org/packages/ba/10/faaf0c9a142106144e27bfda199f83d41e8944851d8b80adc05910929c22/cstar_ocean-0.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e263e50e606fc012ae994f28eb5c99d981378a840fd68ceca4c692cd4c605852",
"md5": "2d62cfadc0a7af3a4522ee98f66a5a08",
"sha256": "5ba2f5d8c1d6fe5f9982c812730cda4fcd46e1a563257b419d377be425ac17b3"
},
"downloads": -1,
"filename": "cstar_ocean-0.0.0.tar.gz",
"has_sig": false,
"md5_digest": "2d62cfadc0a7af3a4522ee98f66a5a08",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 1568178,
"upload_time": "2024-12-09T21:47:26",
"upload_time_iso_8601": "2024-12-09T21:47:26.271397Z",
"url": "https://files.pythonhosted.org/packages/e2/63/e50e606fc012ae994f28eb5c99d981378a840fd68ceca4c692cd4c605852/cstar_ocean-0.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-09 21:47:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "CWorthy-ocean",
"github_project": "C-Star",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cstar-ocean"
}
