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

Installation documentation #249

Closed
1 of 3 tasks
Ulvetanna opened this issue Feb 12, 2024 · 1 comment · Fixed by #251
Closed
1 of 3 tasks

Installation documentation #249

Ulvetanna opened this issue Feb 12, 2024 · 1 comment · Fixed by #251
Assignees
Labels
Bug It might be considered a bug...

Comments

@Ulvetanna
Copy link
Collaborator

Ulvetanna commented Feb 12, 2024

Installation documentation is very complicated for those who haven't been working on the project. This process should be streamlined so new members can install the codebase with ease. Make the assumption that someone will only try once and if that fails will give up on the codebase.

Some of the main issues to be addressed:

  • Documentation is very unclear for installation using venv. Although this is one virtual environment you should have another section using conda installation. The conda installation should be a single line conda create -n PolarRoute polar-route but this does not work due to the next issue
  • PyPI version of PolarRoute is inconsistent.
  • PolarRoute doesn't install clean with MeshiPhi from the Github Repo using 'python setup.py install' and requires a separate PyPI of MeshiPhi.
@Ulvetanna Ulvetanna added the Bug It might be considered a bug... label Feb 12, 2024
@gecoombs gecoombs self-assigned this Feb 13, 2024
@gecoombs gecoombs mentioned this issue Feb 19, 2024
6 tasks
@gecoombs gecoombs linked a pull request Feb 21, 2024 that will close this issue
6 tasks
@gecoombs
Copy link
Member

Installation instructions have been updated and simplified. Mention of venv has been removed and the simplest way to install PolarRoute (from PyPI with pip) is presented first. Installation from a local copy of the source code is now done using pip as using python setup.py install is deprecated and was no longer working when installing into a fresh python environment.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug It might be considered a bug...
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants