Module file system structure of amp
I have started playing with amp. I wanted to discuss about the module file system hierarchy structure. I think a better structure may be:
amp
├── amp
│ ├── analysis.py
│ ├── descriptor
│ ├── __init__.py
│ ├── model
│ ├── model.f90
│ ├── regression
│ ├── tests
│ ├── tools
│ └── utilities.py
├── docs
│ ├── building.rst
│ ├── conf.py
│ ├── develop.rst
│ ├── examplescripts.rst
│ ├── index.rst
│ ├── installation.rst
│ ├── introduction.rst
│ ├── modules
│ ├── moredescriptor.rst
│ ├── moremodel.rst
│ ├── _static
│ ├── theory.rst
│ └── useamp.rst
├── README.md
└── setup.py
Doing this won't affect the package at all but it has the following advantages:
- One does not need to set
PYTHONPATH
in order to importamp
module right away. It is sufficient to just get into the rootamp
directory, launch python console andimport amp
. - Entering the
amp
root directory seems cleaner. - It is the structure used in ASE.
- Lots of projects use the same hierarchy, e.g.: https://github.com/django/django, https://github.com/rpmuller/pyquante2, https://github.com/qutip/qutip.
What do you think about it?. I created a new branch with these changed. As I have to go through all documentation, I will test that everything works with this new structure and I will contact you back later.
In the case you agree, I can do a pull request if you want it. Attached a diff file with the differences with respect to master
.
Sources:
Comments (3)
-
repo owner -
reporter If they do not have anything to do with the
amp/amp/tests
in the second level, I would say they should be in the first levelamp/tests
. -
repo owner - changed status to resolved
Ok, we did this in b2b71e5. I suspect we'll have to fix the nightly tests still.
- Log in to comment
I agree. Also, I just created a "tools" directory which can contain executable, also modeled after where ASE puts executables.
Where do we want "tests"?