Skip to content

Add conda / pip updates to README.md and Documentation #68

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

Draft
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

ma595
Copy link
Collaborator

@ma595 ma595 commented Sep 25, 2022

See #127.

This PR adds improved documentation to the README.md for Conda / Pip deployment and in anticipation of #126 and #129.

Progress towards #127

TODO:

  • rebase

@ma595 ma595 self-assigned this Nov 23, 2023
@ma595 ma595 added build documentation Improvements or additions to documentation labels Nov 23, 2023
@ma595 ma595 changed the title Conda pip updates Conda pip updates to documentation Nov 23, 2023
@ma595 ma595 marked this pull request as draft November 23, 2023 23:20
@ma595 ma595 changed the title Conda pip updates to documentation Add conda / pip updates to README.md and Documentation Dec 2, 2023
@CiSong10
Copy link
Contributor

CiSong10 commented Feb 20, 2025

Hi, thank you for this PR. This helps me build the module!

During testing, I encountered an installation error:

error: subprocess-exited-with-error

  × python setup.py egg_info did not run successfully.
  │ exit code: 1
  ╰─> [34 lines of output]
      Traceback (most recent call last):
      ......
      AttributeError: cython_sources

This appears to be related to Cython version compatibility. Following guidance from this Stack Overflow thread, I resolved the issue by:

$ pip install "cython<3.0.0" wheel
$ pip install "pyyaml==5.4.1" --no-build-isolation
$ pip install -r requirements.txt

I hope this PR can be merged!

@PatBall1
Copy link
Owner

Hi @CiSong10 we were finding it difficult to make things run well through conda before (mostly related to pytorch) but I am open to fixing this. We have conflicts at docs/source/installation.rst and setup.py. Please submit a pull request if you think you can get everything in line.

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

Successfully merging this pull request may close these issues.

3 participants