---
# System prepended metadata

title: Minutes Tudat Developer 14/01/2022

---

# Minutes Tudat Developer 14/01/2022

## Attendees

- Dominic Dirkx
- Kevin Cowan
- Joao De Teixeira da Encarnacao
- Miguel Almeida
- Geoffrey Garrett
- Jonas Hener
- Filippo Oggionni
- Maarten van Nistelrooij
- Jeremie Gaffarel
- Marie-Fayolle Chambe
- Sean Cowan

## Agenda

1. Tudat versioning
2. How to present examples
3. Update on documentation
4. Open source vs. [Knowledge Embargo](https://www.tudelft.nl/en/about-tu-delft/organisation/regulations/knowledge-embargo)

## Tudat(py) versioning

- Scheme was suggested by Geoffrey ([here](https://semver.org/)) and reported on [tudat developer docs](https://tudat-developer.readthedocs.io/en/latest/primer/devops/release_versioning.html#release-versioning)
- Dominic: before tudatpy is set up completely, it does not make sense to increase major version, especially for backwards compatibility
- Filippo: changing the build number only is not working well, especially for students
- Geoffrey: use alpha-beta-etc versioning instead?
- Dominic: probably better to change only minor/patch number for now, before tudatpy is set up completely. Also important to keep a `log` file, see news [workflow](https://tudat-developer.readthedocs.io/en/latest/primer/devops/release_versioning.html#news-workflow) (see [original source](https://regro.github.io/rever-docs/news.html) for missing docs with "TODOs") in the developer docs. 
- Dominic: things that go in the `log`:
    - backward incompatibilities (mandatory)
    - description of what is new (less important, for now)
- Geoffrey: the `log` is located in the source code and the automated changelog is udpated in documentation (see also news [workflow](https://tudat-developer.readthedocs.io/en/latest/primer/devops/release_versioning.html#news-workflow))


### Action points

- [ ] write informative Slack post about this (Filippo)
- [ ] set up github check for the log
- [ ] include log history in tudat-space (see to automate this in the future)
- [ ] merge `develop` branch into `main` and follow correct git workflow indicated [here](https://tudat-developer.readthedocs.io/en/latest/primer/devops/code_collaboration.html#develop-and-master-branches)


## How to present examples
- Filippo: 
    - include examples in Jupyter notebooks, better to illustrate code capabilities, easier to convert to `.rst` (sphinx) files [using nbsphinx](https://nbsphinx.readthedocs.io/en/0.8.8/).
    - [mybinder](https://mybinder.org/): we can setup a website for people to test these notebooks
- Geoffrey: we already have a working example: [Example tudatpy binders](https://github.com/tudat-team/tudatpy-tutorials-binder)
- Kevin: jupyter notebooks to python files is easy, but it is always good to check the output, sometimes there are errors
- Maarten: the converted text into inline comments can be undesired for users, so look into possibilities to remove the text

### Action points
- [ ] convert previous examples to notebooks
- [ ] set up mybinder repo


## Update on documentation

- Filippo:
    - Four paths for documentation:
        - (1) tudat-space, (2) API, (3), developer docs, (4), legacy Tudat C++ pages
    - It would be nice to move some of these paths into tudat-space (in [landing page](https://tudat-space.readthedocs.io/en/latest/) of tudat-space)
    - Documentation on python on tudat-space is good shape, feedback appreciated
    - Not complete, missing some advanced features
    - Overall positive feedback from users
    - Documentation has been split into two general aspects:
        - API intends to describes specific functions
        - tudat-space explains how different objects interact
    - Developer docs
        - implemented by Geoffrey
        - some knowledge present in external sources (Slack, issues, etc) needs to be included there
        - needs to more visible, people are asking about things that are explained there: landing page with links to all developer resources
- Dominic: pictures are easier to refer to the different resources, much better than a bullet list
- Geoffrey:
    - For creating a poliastro-like gallery of tutorials with image links, see the sphinx extension [`sphinx-panels`](https://sphinx-panels.readthedocs.io/en/latest/). 

