Commit af178ff5 authored by Somnath, Suhas's avatar Somnath, Suhas
Browse files

Moved USID links to new repo

parent 9c5220df
......@@ -7,7 +7,7 @@ Pycroscopy
What?
------
* pycroscopy is a `python <http://www.python.org/>`_ package for processing, analyzing, and visualizing multidimensional imaging and spectroscopy data.
* pycroscopy uses the **Universal Spectroscopy and Imaging Data (USID)** `model <https://pycroscopy.github.io/pyUSID/data_format.html>`_ as its foundation, which:
* pycroscopy uses the **Universal Spectroscopy and Imaging Data (USID)** `model <../../USID/index.html>`_ as its foundation, which:
* facilitates the representation of any spectroscopic or imaging data regardless of its origin, modality, size, or dimensionality.
* enables the development of instrument- and modality- agnostic data processing and analysis algorithms.
......@@ -58,7 +58,7 @@ As we see it, there are a few opportunities in scientific imaging (that surely a
How?
-----
* pycroscopy uses the `Universal Spectroscopy and Imaging Data model <https://pycroscopy.github.io/pyUSID/data_format.html>`_ that facilitates the storage of data, regardless
* pycroscopy uses the `Universal Spectroscopy and Imaging Data model <../../USID/index.html>`_ that facilitates the storage of data, regardless
of dimensionality (conventional 1D spectra and 2D images to 9D hyperspectral datasets and beyond!) or instrument of origin (AFMs, STEMs, Raman spectroscopy etc.).
* This generalized representation of data allows us to write a single and
generalized version of analysis and processing functions that can be applied to any kind of data.
......
......@@ -8,7 +8,7 @@ Getting Started
* See `tutorials <https://pycroscopy.github.io/pyUSID/auto_examples/index.html>`_ to get started on using and writing your own pyUSID functions that power pycroscopy
* We already have `many translators <./translators.html>`_ that transform data from popular microscope data formats to pycroscopy compatible HDF5 files.
* pyUSID also has a `tutorial <https://pycroscopy.github.io/pyUSID/auto_examples/beginner/plot_numpy_translator.html>`_ 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) <https://pycroscopy.github.io/pyUSID/data_format.html>`_ model and implementation in HDF5 are also available in pyUSID's documentation.
* Details regarding the definition and guidelines for the Universal Spectroscopy and Imaging Data `(USID) <../../USID/index.html>`_ model and implementation in HDF5 are also available in pyUSID's documentation.
* Please see our document on the `organization of pycroscopy <./package_organization.html>`_ 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 <https://pycroscopy.github.io/pyUSID/contribution_guidelines.html>`_
* If you need detailed documentation on all our classes, functions, etc., please visit our `API <./api.html>`_
......
Data Translators
=================
* Pycroscopy uses ``Translators`` to extract data and metadata from files (often measurement data stored in instrument-generated proprietary file formats) and write them into `Universal Spectroscopy and Imaging Data (USID) HDF5 files <../../pyUSID/data_format.html>`_.
* Pycroscopy uses ``Translators`` to extract data and metadata from files (often measurement data stored in instrument-generated proprietary file formats) and write them into `Universal Spectroscopy and Imaging Data (USID) HDF5 files <../../USID/index.html>`_.
* You can write your own ``Translator`` easily by following `this example <https://pycroscopy.github.io/pyUSID/auto_examples/beginner/plot_numpy_translator.html>`_ on our sister project's documentation.
* Below is a list of ``Translators`` already available in pycroscopy to translate data.
* These translators can be accessed via ``pycroscopy.io.translators`` or ``pycroscopy.translators``
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment