Getting Started

  • Follow these instructions to install pycroscopy
  • See the many journal publications made possible by pycroscopy and try out the jupyter notebooks that were used for the paper
  • Also see examples to see other scientific applications of pycroscopy
  • Python novices are highly recommended to go through Nick Mostovych’s guides and pitfalls for python novices
  • We have also compiled a list of handy tutorials on basic / prerequisite topics such as programming in python, data analytics, machine learning, etc.
  • See tutorials to get started on using and writing your own pyUSID functions that power pycroscopy
  • We already have many translators that transform data from popular microscope data formats to pycroscopy compatible HDF5 files.
    • pyUSID also has a tutorial to get you started on importing your other data to pycroscopy.
  • Details regarding the definition and guidelines for the Universal Spectroscopy and Imaging Data (USID) model and implementation in HDF5 are also available in pyUSID’s documentation.
  • Please see our document on the organization of pycroscopy to find out more on what is where and why.
  • If you are interested in contributing your code to pycroscopy, please look at our guidelines
  • If you need detailed documentation on all our classes, functions, etc., please visit our API
  • Have questions? See our FAQ to see if we have already answered them.
  • Need help or need to get in touch with us? See our contact information.