Installation#
phyem is Python-shelled. You will need a basic level of Python skills to follow this instruction.
Download#
You can download the most recent source code from the GitHub page, git-phyem, by, for example, running the following git command
git clone https://github.com/mathischeap/phyem.git
to clone the package to a local repository.
Config#
The downloaded library is a folder named phyem.
Note that if you download the
zipped library from github, you got a zipped file, for example, called phyem-main. Then you should un-zip it and
rename the folder to phyem.
We now call the folder phyem the package.
Hint
To make phyem library importable, we can do either
put the package in the current working dir.
put the package in a dir that is a default system path.
put the package in a dir which is not a default system path and customize the path locally in Python scripts.
For example, if the package is put in dir abs_dir_of_phyem, in a Python
script or console, you can do
>>> import sys
>>> ph_dir = 'abs_dir_of_phyem'
>>> sys.path.insert(0, ph_dir)
When this script is executed, the path abs_dir_of_phyem will be added to system path temporally.
Of course, if abs_dir_of_phyem is a default system path, you can omit above three lines of code.
Then the phyem library can be imported by
>>> import phyem as ph
>>> print(ph)
If above commands work, phyem is installed in your machine.
Caution
phyem is dependent of other Python packages such as numpy, scipy, matplotlib and so on. Check
phyem/requirements.text for the list of dependencies. They are all
regular Python packages. You can easily install whatever you miss through
for example pip.
Test#
To test the installation of your phyem, you can do
>>> ph.test()
This command calls all predefined testing functions to validate functionalities of phyem in your machine. If it raises error, most likely, it is because of a lack in the environment. Just track the exception and install the missed one(s). When it passes, you are ready to go ahead.
↩️ Back to Welcome.