From 1ba2ef603958d0d06cd06b82d2028c591aa71ab0 Mon Sep 17 00:00:00 2001 From: Matt Johnson Date: Sun, 7 Jul 2024 15:34:38 -0700 Subject: [PATCH] modify readme to reflect changes --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 343b90a..5f2ae67 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file