v1.0.1

[ChrisMcCarthyDev]

YAWNING-TITAN v1.0.1

🐛 Bug Fixes

#30 - # Signature of NetworkInterface causing issues in a few files

This was an issue raised on the dstl/YAWNING-TITAN repo by a member of the community (https://github.com/forrestmckee). This had been an oversight on our part when implementing the updated configs and NetworkInterface instantiation throughout the codebase in v1.0.0.

Issue: #30

🧹 House Keeping

• The papertrail directory with test outputs has been dropped as tests can now be viewed in GitHub Actions.
• An old latex docs build in docs has been dropped.
• Type hints in some config classes have been updated/added.
• Dependencies have been updated. (Poetry will be introduced in a future version to manage dependencies).

☠️ Known Issues

• The start_jupyter_session method in yawning_titan.notebooks.jupyter currently only works on Windows operating system. Follow these steps to get a session running from Linux or MacOS:
  • cd to the NOTEBOOKS_DIR with: cd ~/yawning_titan/notebooks.
  • Activate your env where Yawning-Titan is installed with: source <path to Python bin> activate.
  • Spin-up a Jupyter notebook session with: Jupyter notebook.

✨ How to Install & Run

Install Yawning-Titan

As this is the first versioned release of Yawning-Titan that has lots of API breaking changes, it is recommended that all users perform a new installation by following the code block below for your desired operating system, replacing the <path to downloaded yawningtitan-1.0.1.tar.gz> with the location of the downloaded yawningtitan-1.0.1.tar.gz file.

Windows

mkdir ~\yawning_titan
cd ~\yawning_titan
python3 -m venv .venv
attrib +h .venv /s /d # Hides the .venv directory
.\.venv\Scripts\activate
pip install <path to downloaded yawningtitan-1.0.1.tar.gz>

Unix

mkdir ~/yawning_titan
cd ~/yawning_titan
python3 -m venv .venv
source .venv/bin/activate
pip install <path to downloaded yawningtitan-1.0.1.tar.gz>

Run Jupyter from your Yawning-Titan Virtual Environment

Windows

cd ~\yawning_titan
.\.venv\Scripts\activate
cd notebooks
jupyter notebook

Unix

cd ~/yawning_titan
source .venv/bin/activate
cd notebooks
jupyter notebook

Install Yawning-Titan Dev Environment

The Yawning-Titan repo can be cloned and installed as a dev environment for user customisation. Follow the code block below for your desired operating system.

Windows

mkdir ~\yawning_titan
mkdir ~\yawning_titan\src
cd ~\yawning_titan\src
git clone https://github.com/dstl/YAWNING-TITAN.git
cd YAWNING-TITAN
python3 -m venv .venv
attrib +h .venv /s /d # Hides the .venv directory
.\.venv\Scripts\activate
pip install -e .[dev]

Unix

mkdir ~/yawning_titan
mkdir ~/yawning_titan/src
cd ~/yawning_titan/src
git clone https://github.com/dstl/YAWNING-TITAN.git
cd YAWNING-TITAN
python3 -m venv .venv
source .venv/bin/activate
pip install -e .[dev]

Contributors

• @ChrisMcCarthyDev part of the Yawning-Titan dev team.
• @Rumbelows part of the Yawning-Titan dev team.

Full Changelog: v1.0.0...v1.0.1

---

This discussion was created from the release v1.0.1.