Skip to content

Commit

Permalink
modify readme to reflect changes
Browse files Browse the repository at this point in the history
  • Loading branch information
mjohnson541 committed Jul 7, 2024
1 parent 4c1fa00 commit 1ba2ef6
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,20 @@ In theory this wraps all functionality within RMS with two caveats:

1) In jupyter notebooks julia objects don't display the same way in the python kernel as they would in the julia kernel. For example flux diagram generation had to be hard coded into this wrapper to display properly. If this happens please make an issue.

2) There are ways to define julia functions that makes them impossible to call from python using the pyjulia. In most cases this is easy to fix. If you find a case where this happens please make an issue.
2) There are ways to define julia functions that makes them impossible to call from python. In most cases this is easy to fix. If you find a case where this happens please make an issue.

As a result one should swap the following RMS functions for their pyrms variants:

getfluxdiagram => pygetfluxdiagram
threadedsensitivities => pythreadedsensitivities

## Installation Instructions from Anaconda:

Note: We recommend installing pyrms in its own conda environment when convenient because getting pyjulia to work with conda python efficiently currently requires relinking
the python executable to the python-jl executable, this usually isn't problematic, but it can be an issue in more complicated conda environments.
We recommend installing pyrms in its own conda environment

To Install Binaries with Conda Run:
To Install Binaries with Conda Run:
```
conda install -c rmg pyrms
python -c "import pyrms; pyrms.install()"
ln -sfn $(which python-jl) $(which python)
```

Note the install process occurs automatically on your first import.

0 comments on commit 1ba2ef6

Please sign in to comment.