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.rst #82

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update README.rst #82

wants to merge 1 commit into from

Conversation

lheagy
Copy link
Member

@lheagy lheagy commented Oct 27, 2024

update installation instructions

update installation instructions
Copy link

codecov bot commented Oct 27, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.93%. Comparing base (27a37a5) to head (f5a0538).

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.
📢 Have feedback on the report? Share it here.

@jcapriot
Copy link
Member

We can also add instructions about installing with the optional compiled extensions modules.

The relevant command would be:

pip install . --config-settings=setup-args="-Dwith_extensions=true"

@jcapriot
Copy link
Member

We can also add instructions about installing with the optional compiled extensions modules.

The relevant command would be:

pip install . --config-settings=setup-args="-Dwith_extensions=true"

And maybe mention that the wheel files on pypi and the version installable through conda-forge come with these extensions pre-built.

Copy link
Member

@jcapriot jcapriot left a 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 .
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
pip install -e .
pip install .

No need to recommend an editable install to everyone.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants