providing a subsection in developer guide docs, about automatic code installation#576
providing a subsection in developer guide docs, about automatic code installation#576mikibonacci wants to merge 2 commits into
Conversation
automatic code installation
for more information, see https://pre-commit.ci
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #576 +/- ##
=======================================
Coverage 80.73% 80.73%
=======================================
Files 49 49
Lines 3415 3415
=======================================
Hits 2757 2757
Misses 658 658
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
|
Cool thanks @mikibonacci |
|
yep, fine for me to wait :) thanks |
|
What I should add (from aiidalab meeting discussions):
|
unkcpz
left a comment
There was a problem hiding this comment.
After a second look at #565, I think it requires more discussion on it. Therefore I personally don't want to block this PR and propose to go with calling verdi command to set the code which we test over many releases and should be robust.
The performance issue is caused from verdi command and will be improved a lot after aiida-core v2.5.0 which will soon release.
@mikibonacci thanks for adding this, I added some minor requests, if you can give it a look I'll do a local test with the method you write here.
| Thus, the user needs to set up the codes manually. However, the developer can provide console | ||
| scripts to make user life easier. Please read to following section for some instructions on how | ||
| to do it. |
There was a problem hiding this comment.
We try to break lines for a full sentence to make it easy to review and for future change. Do need to worry about a long line (if it is super long, then probably means it can be cut to short sentences for readability).
| It is possible to provide console scripts in order to make new code installation almost automatic, | ||
| with only running an instruction from the command line. |
There was a problem hiding this comment.
| It is possible to provide console scripts in order to make new code installation almost automatic, | |
| with only running an instruction from the command line. | |
| It is possible to provide console scripts to make new code installation almost automatic, by only running an instruction from the command line. |
| this will invoke the function `install_phonopy`, contained in the phonopy_install.py file in the | ||
| root directory of the package. |
There was a problem hiding this comment.
| this will invoke the function `install_phonopy`, contained in the phonopy_install.py file in the | |
| root directory of the package. | |
| this will invoke the function `install_phonopy`, contained in the `phonopy_install.py` file in the root directory of the package. |
| this will invoke the function `install_phonopy`, contained in the phonopy_install.py file in the | ||
| root directory of the package. | ||
|
|
||
| or in the `setup.cfg` file (if you prefer): |
There was a problem hiding this comment.
| or in the `setup.cfg` file (if you prefer): | |
| Another option is add following lines in the `setup.cfg` file: |
| this will invoke the function `InstallCodes`, contained in the post_install.py file in the | ||
| {root-directory-of-the-package}/aiidalab_qe_muon/scripts/ directory. |
There was a problem hiding this comment.
| this will invoke the function `InstallCodes`, contained in the post_install.py file in the | |
| {root-directory-of-the-package}/aiidalab_qe_muon/scripts/ directory. | |
| This will invoke the function `InstallCodes`, contained in the `post_install.py` file in the `<root-directory-of-the-package>/aiidalab_qe_muon/scripts/` directory. |
No description provided.