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.

Sign up for GitHub

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

Fix environment.yml encoding and improve documentation #25

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix environment.yml encoding and improve documentation #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
99146b8
Fix environment.yml encoding
cbix Dec 9, 2024
cd8bed0
documentation
cbix Dec 9, 2024
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
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should have been there earlier. Thanks

Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,17 @@ This project is currently not meant to be released as a fully-featured alternati
Its purpose is simply to have something to play around with in Python s.t. we can easily explore potential extensions or modifications of the internal structure of CADET (e.g. how to implement pressure, how to treat viscosities etc.).

The project is WIP and not running yet.

## Set up local environment

Create a conda environment from the provided yml file:

```
conda env create -f environment.yml
```

Activate the environment:

```
conda activate cadpythonsim
```
Binary file modified environment.yml
View file
Open in desktop
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Binary file not shown.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That just means github doesn't attempt displaying it. The PR diff still says BIN but for the last commit cd8bed0 you'll see it treated as a text file. I could explicitly add it to .gitattributes but IMO that's not necessary.

Binary file not shown.
Loading