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

Remove hard-coded paths #41

Closed
Flaminietta opened this issue Mar 18, 2024 · 1 comment · Fixed by #42
Closed

Remove hard-coded paths #41

Flaminietta opened this issue Mar 18, 2024 · 1 comment · Fixed by #42
Assignees
Labels
code quality quality of the code improved joss review related issues related to the review process for publication

Comments

@Flaminietta
Copy link
Collaborator

We remove any hard-coded paths from within the code by following the suggestion of @paulrougieux: #19 (comment).

All needed input files (e.g., the input matrix) will be stored in a default directory inside the root directory of ProMCDA. However, the user is allowed to change the position of this directory by setting a custom directory path in the environment:

export CUSTOM_DIRECTORY_PATH=/path/to/custom/directory

This allows the user to customize the directory path without modifying the source code of the Python package.

@Flaminietta Flaminietta added code quality quality of the code improved joss review related issues related to the review process for publication labels Mar 18, 2024
@Flaminietta Flaminietta self-assigned this Mar 18, 2024
@paulrougieux
Copy link

  • Great that the directory can be specified with an environment variable.
  • Users might have many packages on their systems which require configuration through environment variables. the name of the environment variable should include the name of your package for example PROMCDA_DIR, PROMCDA_DIRECTORY_PATH, or similar.

@Flaminietta Flaminietta linked a pull request Mar 20, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code quality quality of the code improved joss review related issues related to the review process for publication
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants