https://github.com/alan-turing-institute/dodo
Scaffold for ATC agents
Science Score: 10.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
○codemeta.json file
-
○.zenodo.json file
-
○DOI references
-
○Academic publication links
-
✓Committers with academic emails
1 of 7 committers (14.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (17.0%) to scientific vocabulary
Keywords from Contributors
Repository
Scaffold for ATC agents
Basic Info
- Host: GitHub
- Owner: alan-turing-institute
- License: mit
- Default Branch: master
- Size: 667 KB
Statistics
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
Active development moved under Project BlueBird.
Dodo
Overview
Dodo is a package that provides a scaffold for building air traffic control agents, as part of the Simurgh project. The packages is written in Python (PyDodo) and R (rdodo).
Note that the package is built to communicate with BlueBird version >= 2.0.
All the default settings and parameter values (e.g., BlueBird version number) are specified in a common configuration file.
For an overview of all functionality, please read the specification document.
Contents
PyDodo
PyDodo installation
(Optional first step)
conda create -n pydodo python=3.7
conda activate pydodo
...
{bash}
git clone https://github.com/alan-turing-institute/dodo.git
cd dodo/PyDodo
pip install .
PyDodo usage
If BlueBird (and a simulator) are running, then one can communicate with BlueBird using PyDodo. For example:
```python
import pydodo
pydodo.reset_simulation() True
```
The specification document gives a detailed overview of the supported commands.
See the example notebook in the Simurgh project repository for a run through of how to use PyDodo to interact with BlueBird.
PyDodo development
Tests
Run the tests from the project root:
pytest PyDodo/
If BlueSky and BlueBird are running and PyDodo can connect to them, all tests are run. Otherwise integration tests are skipped and only unit tests are run.
Style guide
Docstrings should follow numpydoc convention. We encourage extensive documentation.
The python code itself should follow PEP8 convention whenever possible, with at most about 500 lines of code (not including docstrings) per script.
To format the code we recommend using the black code formatter.
rdodo
rdodo installation
rdodo usage
rdodo development
Contributing
If you have any questions that aren't discussed here, please let us know by opening an issue.
We welcome all contributions from documentation to testing to writing code. Don't let trying to be perfect get in the way of being good - exciting ideas are more important than perfect pull requests.
To contribute to PyDodo or rdodo development, please check the corresponding section (PyDodo development or rdodo development for details.
To implement Dodo in another programming language, please follow the specification document. The shared configuration file specifies common required parameters and settings.
Owner
- Name: The Alan Turing Institute
- Login: alan-turing-institute
- Kind: organization
- Email: info@turing.ac.uk
- Website: https://turing.ac.uk
- Repositories: 477
- Profile: https://github.com/alan-turing-institute
The UK's national institute for data science and artificial intelligence.
GitHub Events
Total
Last Year
Committers
Last synced: over 2 years ago
Top Committers
| Name | Commits | |
|---|---|---|
| radka-j | r****a@g****m | 323 |
| Tim Hobson | t****n@t****k | 132 |
| Tarek Allam | t****r@g****m | 59 |
| Ruairidh MacLeod | 5****m | 9 |
| Evelina Gabasova | e****a@e****m | 6 |
| Tim Hobson | t****8@g****m | 3 |
| Ruairidh MacLeod | r****h@r****v | 2 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: over 2 years ago
All Time
- Total issues: 0
- Total pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Total issue authors: 0
- Total pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0