README.md

memory-testing

Generated files from the memory testing CI.

It is unlilely you should be interacting with this repository. Index files are added by the Chaste memory testing workflow.

⚠️ If fiddling with this manually is essential, then:

Requirements

• Python 3.11+ (tested)
• pip install -r requirements.txt

Usage

1. Place log directories (with index.html) or .tar.xz archives under log-files/.
2. Run python write_index.py.
3. Open log-files/index.html in a browser.

Archiving old files and re-writing history

⚠️ ⚠️ ⚠️ this is highly destructive. Only follow these instructions if you're certain you know what you're doing.

To keep this repo (specifically, the working tree) relatively small, with plenty of space to upload to GitHub pages, we periodically archive old plaintext files and replace them with a .tar.xz.

We, additionally, purge the history of the old text files, which helps keep the repository itself a manageable size.

By default, we archive all records older than one year.

1. pip install -r requirements.txt
2. From the root directory: python archive_old.py
3. Check, and commit .tar.xz files
4. From the root directory: python amend_history.py
5. CHECK THAT THE AMENDED HISTORY LOOKS GOOD
6. Manually re-write the index: python write_index.py
7. Check, and commit log-files/index.html
8. Add origin back: git remote add origin git@github.com:Chaste/memory-testing.git
9. DOUBLE CHECK EVERYTHING LOOKS GOOD
10. git push --force --all
11. git push --force --tags