https://github.com/mretegan/diffeq

Differential Equations
https://github.com/mretegan/diffeq

Last synced: 3 days ago
JSON representation

Differential Equations

• Host: GitHub
• URL: https://github.com/mretegan/diffeq
• Owner: mretegan
• Created: 2023-10-09T13:26:59.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-09T13:43:35.000Z (about 1 year ago)
• Last Synced: 2024-11-07T17:59:34.360Z (about 2 months ago)
• Language: Jupyter Notebook
• Size: 12.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# How to use this repository

After cloning this repository, you can use the notebooks and build the documentation by following these steps:

1. Create the Conda/Mamba environment:

    ```sh

    mamba env create -f environment.yml

    ```

    This will create an environment called `diffeq` with all the dependencies needed to run the notebooks and build the documentation.

2. Activate the environment

    ```sh

    conda activate diffeq

    ```

3. For running the notebooks in presentation mode, first start the notebook server:

    ```sh

    jupyter notebook

    ```

    Then, open the notebook and click on the "Enter/Exit RISE Slideshow" button in the toolbar (it looks like a bar chart).

    You can assign the type of slide to each cell using the "Slide Type" dropdown menu on the right-hand side. If you don't see the toolbar, click on "View" -> "Cell Toolbar" -> "Slideshow".

4. To build the documentation, run:

    ```sh

    make html

    ```

    The documentation will be built in the `_build` directory. To view it, open `_build/html/index.html` in your browser.

5. Run `clean-notebooks.sh` to remove the output from the notebooks and to automatically format the code using Black. This is useful before committing changes to the repository.