https://github.com/cambridge-iccs/tctrack
Code associated with the ICCS tropical cyclone tracking project
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (18.4%) to scientific vocabulary
Repository
Code associated with the ICCS tropical cyclone tracking project
Basic Info
- Host: GitHub
- Owner: Cambridge-ICCS
- License: mit
- Language: Python
- Default Branch: main
- Homepage: https://tctrack.readthedocs.io
- Size: 210 KB
Statistics
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 17
- Releases: 0
Metadata Files
README.md
TCTrack
The TCTrack package aims to provide functionality for running tropical cyclone (TC) tracking algorithms and analysing the results. This can be used to compare the output of different algorithms for a variety of data sources.
[!WARNING]
The software is currently in early development and therefore subject to significant changes.
Installation
Dependencies
The package requires Python 3 (>=3.10).
Package Installation
First clone the repository using git:
sh
git clone https://github.com/Cambridge-ICCS/TCTrack
Set up and activate a virtual environment:
sh
python3 -m venv .venv
source .venv/bin/activate
When finished using TCTrack this can be turned off with deactivate.
Then install the package using pip:
sh
pip install --editable .
Using TCTrack
To use TCTrack from within Python after install import it as you would any other library:
```python import tctrack
[Example]
```
Full details can be found in the getting-started documentation online. For a complete description of the library API see API documentation.
Contributing
Contributions and collaborations are welcome.
For bugs, feature requests, and clear suggestions for improvement please open an issue.
If you have added something to TCTrack that would be useful to others, or can address an open issue, please fork the repository and open a pull request.
Additional dependencies for deleopment can be installed as follows:
sh
pip install --editable .[dev]
Full details for contribution and developers can be found in the online documentation.
Code of Conduct
Everyone participating in the TCTrack project, and in particular in the issue tracker, pull requests, and social media activity, is expected to treat other people with respect and, more generally, to follow the guidelines articulated in the Python Community Code of Conduct.
License
Copyright © ICCS
TCTrack is distributed under the GPL 3.
Owner
- Name: Institute of Computing for Climate Science
- Login: Cambridge-ICCS
- Kind: organization
- Website: https://cambridge-iccs.github.io/
- Twitter: Cambridge_ICCS
- Repositories: 8
- Profile: https://github.com/Cambridge-ICCS
Institute of Computing for Climate Science at the University of Cambridge
GitHub Events
Total
- Create event: 15
- Issues event: 32
- Watch event: 1
- Delete event: 12
- Issue comment event: 30
- Member event: 1
- Push event: 90
- Pull request review comment event: 45
- Pull request review event: 58
- Pull request event: 26
Last Year
- Create event: 15
- Issues event: 32
- Watch event: 1
- Delete event: 12
- Issue comment event: 30
- Member event: 1
- Push event: 90
- Pull request review comment event: 45
- Pull request review event: 58
- Pull request event: 26
Issues and Pull Requests
Last synced: 10 months ago
All Time
- Total issues: 23
- Total pull requests: 16
- Average time to close issues: 28 days
- Average time to close pull requests: 12 days
- Total issue authors: 3
- Total pull request authors: 2
- Average comments per issue: 0.26
- Average comments per pull request: 0.5
- Merged pull requests: 8
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 23
- Pull requests: 16
- Average time to close issues: 28 days
- Average time to close pull requests: 12 days
- Issue authors: 3
- Pull request authors: 2
- Average comments per issue: 0.26
- Average comments per pull request: 0.5
- Merged pull requests: 8
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- jatkinson1000 (19)
- sjavis (3)
- qntmCharles (1)
Pull Request Authors
- jatkinson1000 (9)
- sjavis (7)