Skip to content

Commit

Permalink
Update TODO.md
Browse files Browse the repository at this point in the history
- checked code with linters
- fixed some bugs 
- made package pip installable
  • Loading branch information
CalystaT committed Aug 18, 2023
1 parent 6b87785 commit b2988fc
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions TODO.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@
- [x] Formatting & cleanup of files
* Remove unused imports (e.g. if package/function is imported but not used etc)
* Maybe some reorganization and renaming of input files to make it more user-friendly (alpha_tools.py etc)?
- [ ] Generate documentation (with `sphinx`)
- [x] Generate documentation (with `sphinx`)
* Quickstart guide on using `sphinx` [here](https://www.sphinx-doc.org/en/master/usage/quickstart.html)
* The docs should include 3 main pages:
1. Intro to what the package can do (index.rst)
2. Python API for main functions (main_functions.rst)
3. A good tutorial (as Jupyter Notebook) exemplifying the main functions & workflow
* The notebook should combine `Markdown` and `Code` cells to explain the workflow, showing the outputs/plots etc
- [ ] Publish docs in `Readthedocs`
- [ ] Installation
- [ ] Enable `pip` install: this requires adding package to [pypi](https://pypi.org/)
- [x] Installation
- [x] Enable `pip` install: this requires adding package to [pypi](https://pypi.org/)
- [x] Update tutorial 1 to rewrite long code snippets as functions
- [ ] Checking code & docstrings formatting with linters
- [x] Checking code & docstrings formatting with linters
* Using the packages `isort`, `black`, `pycodestyle`, `flake8`
- [ ] Write up `JOSS` paper
- Some examples here:
Expand Down

0 comments on commit b2988fc

Please sign in to comment.