gnikit
74ee6ed58e
chore: renamed table header
2022-07-21 10:44:32 +01:00
gnikit
f5e7e816dd
Apply suggestions from code review
...
Co-authored-by: Jeremy Cohen <jcohen02@users.noreply.github.com>
2022-07-20 00:46:37 +01:00
gnikit
27453fcf95
docs: edited README to adhere to template
...
Template can be found in:
https://raw.githubusercontent.com/ImperialCollegeLondon/ReCoDE-README-template/main/README-template.md?token=GHSAT0AAAAAABPRNXTZCOF7UC74ZT5T5P5YYWWUL3A
2022-07-19 12:29:53 +01:00
gnikit
13190e66cc
chore: updated link to ImperialCollegeLondon
...
Also removed duplicate link to Jupyter notebooks
2022-07-19 11:29:35 +01:00
gnikit
b545ffbc20
docs: Add GitHub clone instructions at Intro
2022-07-19 11:28:09 +01:00
gnikit
6d656cc436
docs: move API docs at the end of the exemplar
2022-07-19 10:34:36 +01:00
gnikit
d54a11f270
chore: fix string formatting
2022-07-19 10:34:01 +01:00
gnikit
64e2dc119c
docs: add descriptions to sphinx exts + mathajax
2022-07-19 10:33:43 +01:00
gnikit
197a53ce3c
docs: fix math rendering in sphinx website
2022-07-19 01:07:11 +01:00
gnikit
3443455cf9
fix: multiple changes in the Jupyter notebooks
...
- Replaces references to `code` to `src`
- Adds language attributes to fenced code blocks
- Updates output of `setup.cfg` in notebook 2.
- Fixes spelling and grammar errors
2022-07-18 23:56:42 +01:00
gnikit
7e5f20aa2d
fix: name conflict with other exemplars
...
The venv cannot be named recode, since a student might be working
through multiple exemplars which would lead to name conflicts
for the venvs.
I named the conda venv mcmc for Monte Carlo Markov Chain.
2022-07-18 17:05:46 +01:00
gnikit
673a458761
docs: moves notebook figures to _assets for sphinx
...
There was an issue with static assets not being properly copied in
the sphinx documentation. The assets have now been moved to
`_static` to ensure that sphinx is able to copy them during build.
The Jupyter notebooks use the images from `_static`.
2022-07-18 16:09:50 +01:00
gnikit
5d1f7d08e9
chore: move dev dependencies from default to dev
2022-07-18 15:45:16 +01:00
gnikit
f703e0f66e
docs: update README.md
2022-07-18 15:44:15 +01:00
gnikit
687187239f
chore: remove duplicate dependency
2022-07-18 15:31:05 +01:00
gnikit
88529641c6
Merge pull request #3 from gnikit/main
...
Move dependencies into `setup.cfg`
2022-07-18 07:18:31 -07:00
gnikit
6b1af29bd9
docs: remove GitHub Action since unused
2022-07-18 13:15:43 +01:00
gnikit
4f8afc663e
Merge branch 'main' into main
2022-07-18 05:08:38 -07:00
237ba25165
Fix last couple doc build errors
2022-07-18 11:54:35 +01:00
de56741a51
Add watermarks to all notebooks and fix images
2022-07-18 11:50:25 +01:00
03657e0883
Move requirements to setup.cfg
2022-07-18 11:24:27 +01:00
gnikit
f68a8522e8
Add docs GitHub Action
...
This is a temporary solution until we figure out how to
deploy readthedocs via GitHub Actions on a GitHub page.
2022-07-18 11:21:56 +01:00
gnikit
f944a7edfe
fix: jupyter-lab dependency name
...
Also pins version
2022-07-18 11:09:55 +01:00
gnikit
142abfd5c7
fix: moves packaging requirements to setup.cfg
...
Also moves documentation and development requirements to
targets [docs] and [dev] respectively.
2022-07-18 10:58:55 +01:00
gnikit
3ede4829a3
chore: format README
2022-07-17 22:48:19 +01:00
107dae0201
add reproducible plotting section
2022-07-17 16:44:23 +01:00
339040fcf5
updates
2022-07-17 16:43:57 +01:00
42b1bb6959
update testing section
2022-07-17 16:43:37 +01:00
63523481e8
Updates!
2022-06-30 11:57:05 +01:00
4c33524345
update README and 02 to reflect new layout
2022-06-17 12:57:48 +02:00
b2e3449ff2
move to a more standard directory structure
2022-06-17 12:41:41 +02:00
d2258ae35c
Reformat the docs and add myst-nb as a doc dep
2022-06-17 12:23:40 +02:00
b8392ed703
Move all the notebooks into the docs/ folder
2022-06-17 12:22:37 +02:00
e6f62333cd
update path to MCFF package
2022-06-16 17:16:01 +02:00
c413bdf387
make readthedocs install the MCFF package too
2022-06-16 17:13:05 +02:00
668c3dd771
Create readthedocs.yaml
2022-06-16 17:08:34 +02:00
8fd35ba0bd
Add sphinx docs
2022-06-16 17:02:32 +02:00
6961575276
globally remove the 1/L**2 factor from definitions
2022-06-16 14:54:52 +02:00
1fc68aa565
Split a lot of notebooks
2022-06-16 14:00:28 +02:00
a772b43fa7
Add improved versions to the MCFF package
2022-06-16 14:00:01 +02:00
99974d506b
Add new implementation of mcmc to chapter 2
2022-06-10 09:44:58 +02:00
c0df87bc3a
Expand chapter 1
2022-06-09 13:42:18 +02:00
1f8dbc0c89
Add pre-commit hook section to chapter 3
...
create pre-commit hooks
2022-06-09 10:36:05 +02:00
9eb933cb14
run black on everything
...
autoformatting
2022-06-09 10:34:39 +02:00
9de5c8c303
revert pyproject.toml to default state
2022-06-09 09:56:06 +02:00
da28951623
update learning materials
2022-06-09 09:55:49 +02:00
615558cb38
Update license (again)
2022-06-01 14:34:43 +02:00
c8acaadb0b
Update license
2022-06-01 14:30:08 +02:00
45f832f18a
Merge pull request #1 from TomHodson/fix/index_typos
2022-06-01 13:42:54 +02:00
Jeremy Cohen
a503ce5a76
Minor typo fixes and suggested updates
...
This is looking great @TomHodson. Feel free to review and request changes to my updates where I've made minor changes to the text.
2022-06-01 12:19:08 +01:00
