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

Fix installation instructions #520

Merged
merged 4 commits into from
Aug 13, 2024
Merged

Fix installation instructions #520

merged 4 commits into from
Aug 13, 2024

Conversation

halungge
Copy link
Contributor

@halungge halungge commented Aug 8, 2024

(FIX) install instructions

  • adds root level tox.ini containing dev env settings only
  • adapt instructions README.md
  • use wildcard to exclude test discovery of _external_src independently of path

adapt instructions README.md
fix excludes of _external_src in pytest configuration
@halungge halungge requested a review from samkellerhals August 8, 2024 10:02
@halungge
Copy link
Contributor Author

halungge commented Aug 8, 2024

cscs-ci run default

@halungge
Copy link
Contributor Author

halungge commented Aug 8, 2024

launch jenkins spack

```

If you want to proceed manually, you should install all packages at once by using the provided `requirements.txt` or `requirements-dev.txt` files in the root of the repository. For example:
You can install all packages at once by using the provided `requirements.txt` or `requirements-dev.txt` files in the root of the repository. For example:
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe mentione here that the dev build installs packages in editable mode and so makes it easier for development in case any of the sources of the dependent packages have to be changed by the developer.

Copy link
Contributor Author

@halungge halungge Aug 8, 2024

Choose a reason for hiding this comment

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

I also added a list of external dependencies, is not listed anywhere. I am actually unsure about the Python versions. I run 3.10 but I think some people run with 3.11. Is that true?

add external dependencies
@halungge halungge requested a review from samkellerhals August 8, 2024 14:19
@halungge
Copy link
Contributor Author

halungge commented Aug 8, 2024

launch jenkins spack

@halungge
Copy link
Contributor Author

halungge commented Aug 8, 2024

cscs-ci run default

Copy link

github-actions bot commented Aug 9, 2024

Mandatory Tests

Please make sure you run these tests via comment before you merge!

  • cscs-ci run default
  • launch jenkins spack

Optional Tests

To run benchmarks you can use:

  • cscs-ci run benchmark

To run tests and benchmarks with the DaCe backend you can use:

  • cscs-ci run dace

In case your change might affect downstream icon-exclaim, please consider running

  • launch jenkins icon

For more detailed information please look at CI in the EXCLAIM universe.

@halungge
Copy link
Contributor Author

halungge commented Aug 9, 2024

cscs-ci run default

@halungge
Copy link
Contributor Author

halungge commented Aug 9, 2024

launch jenkins spack

@halungge halungge merged commit 0aab0a3 into main Aug 13, 2024
5 checks passed
@halungge halungge deleted the fix_build_instructions branch December 12, 2024 06:59
OngChia pushed a commit that referenced this pull request Jan 14, 2025
* add root level tox.ini containing dev env settings only
adapt instructions README.md
fix excludes of _external_src in pytest configuration

* add tox installation

* add explanation of -dev.txt
add external dependencies

* remove Python 3.11
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