-
Notifications
You must be signed in to change notification settings - Fork 867
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
Clean up CONTRIBUTING.md
docs and change _is_named_isotope
getattr
default value
#4174
Clean up CONTRIBUTING.md
docs and change _is_named_isotope
getattr
default value
#4174
Conversation
|
||
```sh | ||
git clone https://github.com/<username>/pymatgen | ||
|
||
# (Alternative/Much Faster) If you don't need a full commit history/other branches | ||
# git clone --depth 1 https://github.com/<username>/pymatgen |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think it might be good to provide this alternative as I think most new contributors don't really need the complete commit history or other branches, they would just branch from main.
To clone the complete repo:
git clone https://github.com/materialsproject/pymatgen.git 48.11s user 15.68s system 69% cpu 1:31.62 total
Depth one clone:
git clone https://github.com/materialsproject/pymatgen.git --depth 1 7.60s user 2.75s system 31% cpu 32.622 total
|
||
```sh | ||
cd path/to/repo | ||
pip install -e . # install the package in your environment as "editable" == dev package | ||
PMG_TEST_FILES_DIR=$(pwd)/tests/files pytest tests # run the test suite providing the path for the datafiles |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe setting PMG_TEST_FILES_DIR
is not needed for editable mode, however we might still leave the "non-editable install + set PMG_TEST_FILES_DIR" as an option here, as there might be users who want to install the package in non-editable mode but still run tests, say people who don't intend to develop pymatgen
and just run tests to verify pymatgen
integration.
False
overNone
might be more conventional (we should not use truthy to checkNone
):CONTRIBUTING.md
PMG_TEST_FILES_DIR
when running unit test