tom/ReCoDE_MCMCFF
1
0
Fork 0
mirror of https://github.com/ImperialCollegeLondon/ReCoDE_MCMCFF.git synced 2025-06-26 08:51:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: update README.md

Browse Source
This commit is contained in:
gnikit 2022-07-18 15:44:15 +01:00
parent 687187239f
commit f703e0f66e
No known key found for this signature in database
GPG Key ID: E9A03930196133F0
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -36,7 +36,7 @@ Rather this project is primarily designed to showcase the tools and practices av
## How to use this repository ## How to use this repository
Take a look at a the table of contents below and see if there are any topics that might be useful to you. The actual code lives in `./code` and the documentation in `./docs/learning` Take a look at the table of contents below and see if there are any topics that might be useful to you. The actual code lives in `src` and the documentation in `docs/learning` in the form of Jupyter notebooks.
When you're ready to dive in you have three options: When you're ready to dive in you have three options:
@ -44,12 +44,12 @@ When you're ready to dive in you have three options:
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ImperialCollegeLondon/ReCoDE_MCMCFF/HEAD?urlpath=lab%2Ftree%2Fdocs%2Flearning%2F01%20Introduction.ipynb) [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/ImperialCollegeLondon/ReCoDE_MCMCFF/HEAD?urlpath=lab%2Ftree%2Fdocs%2Flearning%2F01%20Introduction.ipynb)
### 2. Clone the repo and run the jupyter notebooks locally. (Faster but requires you have python/jupyter installed) ### 2. Clone the repo and run the Jupyter notebooks locally. (Faster but requires you have python/jupyter installed)
``` ```bash
git clone git clone https://github.com/ImperialCollegeLondon/ReCoDE_MCMCFF mcmc
cd cd mcmc
pip install -r requirements.txt pip install .[dev]
jupyter lab jupyter lab
``` ```
@ -65,7 +65,7 @@ jupyter lab
├── docs ├── docs
│ ├── ... #Files to do with making the documentation │ ├── ... #Files to do with making the documentation
│ └── learning │ └── learning
│ └── #The Jupyer notebooks that form the main body of this project │ └── #The Jupyter notebooks that form the main body of this project
│ │
├── pyproject.toml # Machine readable information about the MCFF package ├── pyproject.toml # Machine readable information about the MCFF package
├── readthedocs.yaml # Tells readthedocs.com how to build the documentation ├── readthedocs.yaml # Tells readthedocs.com how to build the documentation