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.

Sign up for GitHub

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

Jump to bottom

No env control in installation instructions #58

Closed
fredshone opened this issue Jun 25, 2024 · 1 comment · Fixed by #70
Closed

No env control in installation instructions #58

fredshone opened this issue Jun 25, 2024 · 1 comment · Fixed by #70
Assignees
@samgdotson
Labels
Comp:Build This issue has to do with the build system of the code/doc (makefiles, cmake, install errors) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:2-Normal This work is important and should be completed ASAP. Status:2-Backlog This issue has been claimed, but it's not being worked on right now, and it's not next to be tackled Type:Feature New feature or feature request
Milestone
JOSS publication ...

Comments

@fredshone
Copy link
Contributor

I think it is a good idea to include an env/package manager such as conda or mamba in the installation instructions.

  • This will create more homogenous experience for users on different OS
  • You should get less awkward bug reports from less expereinced users

There is an example of a (also energy) project that makes use of mamba here.
@fredshone fredshone mentioned this issue Jun 25, 2024
Open
@samgdotson samgdotson self-assigned this Jul 30, 2024
@samgdotson samgdotson added this to the JOSS publication -- Osier milestone Jul 30, 2024
@samgdotson samgdotson added Comp:Build This issue has to do with the build system of the code/doc (makefiles, cmake, install errors) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:2-Normal This work is important and should be completed ASAP. Status:2-Backlog This issue has been claimed, but it's not being worked on right now, and it's not next to be tackled Type:Feature New feature or feature request labels Jul 31, 2024
@victoraalves
Copy link

Agreed.

@samgdotson samgdotson mentioned this issue Oct 4, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@samgdotson samgdotson

Labels
Comp:Build This issue has to do with the build system of the code/doc (makefiles, cmake, install errors) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:2-Normal This work is important and should be completed ASAP. Status:2-Backlog This issue has been claimed, but it's not being worked on right now, and it's not next to be tackled Type:Feature New feature or feature request
Projects
None yet
Milestone
JOSS publication -- Osier
Development

Successfully merging a pull request may close this issue.

Env instructions samgdotson/osier
3 participants
@fredshone @samgdotson @victoraalves