Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add aeon_mecha installation docs #22

Merged
merged 18 commits into from
Sep 26, 2024

Conversation

lochhh
Copy link
Collaborator

@lochhh lochhh commented Apr 23, 2024

This PR

  • updates the installation instructions for setting up aeon_mecha both locally and remotely
  • adds example notebooks to the User Guide

To summarise:

  • Users are asked to set up a new conda env with python, and then pip install aeon_mecha (and its dependencies listed in the pyproject.toml)
  • For accessing Aeon data locally, users are pointed to instructions to mount the Ceph storage onto their local machines
  • For accessing Aeon data remotely using an IDE, users are pointed to instructions to edit the SSH config and to set up remote development on their IDEs online docs
  • For interacting with Aeon data, a couple of example (placeholder) notebooks have been added to the User Guide
  • The example notebooks were added manually to src/user/tutorials because the current notebooks we have on aeon_analysis or aeon_mecha are not "properly formatted" (e.g. notebooks are missing H1 titles, required by Sphinx to build the HTML page)
  • Because we are unable to "include" .ipynbs from outside of the docs src dir, the copy_examples_to_src.py script copies notebooks from provided source dir(s) to the docs src dir

The changes can be previewed on the forked repo website.

@lochhh lochhh marked this pull request as ready for review April 25, 2024 13:55
@lochhh lochhh requested a review from jkbhagatio April 25, 2024 13:55
@lochhh lochhh merged commit 47329ed into SainsburyWellcomeCentre:main Sep 26, 2024
2 checks passed
@lochhh lochhh deleted the installation branch September 26, 2024 10:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant