-
Notifications
You must be signed in to change notification settings - Fork 11
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.rst #82
base: main
Are you sure you want to change the base?
Conversation
update installation instructions
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #82 +/- ##
=======================================
Coverage 85.93% 85.93%
=======================================
Files 31 31
Lines 3149 3149
=======================================
Hits 2706 2706
Misses 443 443 ☔ View full report in Codecov by Sentry. |
We can also add instructions about installing with the optional compiled extensions modules. The relevant command would be:
|
And maybe mention that the wheel files on pypi and the version installable through conda-forge come with these extensions pre-built. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just realizing I left this as pending...
@@ -70,7 +70,7 @@ To install from source, you can | |||
.. code:: | |||
|
|||
git clone https://github.com/simpeg/geoana.git | |||
python setup.py install | |||
pip install -e . |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
pip install -e . | |
pip install . |
No need to recommend an editable install to everyone.
update installation instructions