epytaxy is a python software package to read and analyse datafiles that is typically seen in epitaxial thin film research. This includes instruments within our lab, other specialised labs we access, as well as national research infrastructure. The package is split into 3 sections:

1. Scanning probe microscopy epytaxy.spm
   • Asylum Cypher single-frequency piezoresponse force microscopy (PFM) epytaxy.spm.AsylumSF
   • Asylum Cypher Dual-Amplitude Resonance Tracking (DART) PFM epytaxy.spm.AsylumDART
   • Bruker multimode AFM and PFM
2. X-ray scattering epytaxy.xray
   • X-ray reflectometry (XRR) epytaxy.xray.reduce_xray
   • X-ray diffraction line-scan (XRD) epytaxy.xray.ras_file, epytaxy.xray.xrdml_file
   • X-ray reciprocal space map (RSM) epytaxy.xray.ReciprocalSpaceMap
3. Neutron scattering epytaxy.neutron
   • TAIPAN triple-axis spectrometer epytaxy.neutron.TaipanNexus, epytaxy.neutron.TaipanRSM

Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

Open a terminal and run the following git command:

git clone "url you just copied"

where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.

For example:

git clone https://github.com/this-is-you/epytaxy.git

where this-is-you is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer.

First, check that pip is installed in your conda environment by typing conda install pip. Then, navigate to the directory where the cloned epytaxy folder is held (e.g. cd C:\Users\user_name\Documents\code if the epytaxy package is in the code folder). Then do the following:

pip install -r epytaxy/requirements.txt

This will go through the requirements text file and install the relevant versions of each package that epytaxy depends on. After all these have finished installing, we can now install the epytaxy package:

pip install -e epytaxy

where the -e flag tells pip that the package should be installed locally from the files you have downloaded from the github repository.