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

Update README.md #36

Merged
merged 1 commit into from
Mar 24, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ You will need to have an up-to-date Python installation, e.g., through [Anaconda

## Use

Once you have cloned this repository to your local machine, use the `dea.ipynb` file to prepare your data and run the diffusion entropy analysis.
Once you have cloned this repository to your local machine, use the `dea.ipynb` file to prepare your data and run the diffusion entropy analysis. A user guide and quick reference are provided on [the wiki](https://github.com/garland-culbreth/Diffusion-Entropy-Analysis/wiki).

### dea.ipynb
This Jupyter notebook is for working with real data. It imports functions from the `dea.py` module to make code cells as simple as possible, and contains markdown discussing how to use the method and interpret the results.
Expand Down
Loading