We commend you to visit the release page of phyem git repository, Releases, to download the most recent stable version, v0.0.1.

You can also download the most recent (maybe not thoroughly tested) source code from the GitHub page, git-phyem, by, for example, running the following git command

git clone

to clone the package to a local repository. Nevertheless, downloading a stable version from the Releases page is more recommended.


The downloaded (and maybe unzipped) library is a folder named phyem. We now call this folder the package.


To make phyem library importable, we can do either

  • 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.

And we recommend the section way to keep the default system path clean.

For example, if the package is put in dir ~/my_packages/, in a Python script or console, you can do

>>> import sys
>>> ph_dir = '~/my_packages/'
>>> sys.path.append(ph_dir)

When this script is executed, the path ~/my_packages/ will be added to system path temporally. Of course, if ~/my_packages/ 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 ready in your machine.


phyem is dependent of other Python packages such as numpy, scipy, matplotlib and so on. Check phyem/requirements.text for the list of dependencies and install whatever you miss through for example pip.

↩️ Back to Welcome.