Commit 9ea2af29 authored by Unknown's avatar Unknown
Browse files

Merge remote-tracking branch 'origin/master'

parents f18a92de 0e7c5107
......@@ -75,6 +75,7 @@ Getting Started
* For more information about our functions and classes, please see our `API <https://pycroscopy.github.io/pycroscopy/pycroscopy.html>`_
* We have many translators that transform data from popular microscope data formats to pycroscopy compatible .h5 files. We also have `tutorials to get you started on importing your data to pycroscopy <https://pycroscopy.github.io/pycroscopy/auto_examples/plot_translator_tutorial.html#sphx-glr-auto-examples-plot-translator-tutorial-py>`_.
* Details regarding the defention, implementation, and guidelines for pycroscopy's `data format <https://github.com/pycroscopy/pycroscopy/blob/master/docs/Data_Format.md>`_ for `HDF5 <https://github.com/pycroscopy/pycroscopy/blob/master/docs/Pycroscopy_Data_Formatting.pdf>`_ are also available.
* If you are interested in contributing and are looking for topics we are / will work on, please look at our `To Do <https://github.com/pycroscopy/pycroscopy/blob/master/ToDo.rst>`_ page
Journal Papers using pycroscopy
-------------------------------
......@@ -104,5 +105,3 @@ Contact us
* Join our slack project at https://pycroscopy.slack.com to discuss about pycroscopy
* Feel free to get in touch with us at pycroscopy (at) gmail [dot] com
* If you find any bugs or if you want a feature added to pycroscopy, raise an `issue <https://github.com/pycroscopy/pycroscopy/issues>`_. You will need a free Github account to do this
* If you would like to help us and are looking for topics we are / will work on, please look at our `To Do <https://github.com/pycroscopy/pycroscopy/blob/master/ToDo.rst>`_ page
.. contents::
Roadmap / Milestones
--------------------
1. Sep 2017 end - Cleaned versions of the main modules (Analysis pending) + enough documentation for users and developers
2. Oct 2017 mid - Multi-node compute capability
New features
------------
Core development
~~~~~~~~~~~~~~~~
* Simplify and demystify analyis / optimize. Use parallel_compute and joblib
* multi-node computing capability in parallel_compute
* Data Generators
External user contributions
......@@ -13,7 +19,6 @@ External user contributions
* Ondrej Dyck’s atom finding code – written but needs work before fully integrated
* Nina Wisinger’s processing code (Tselev) – in progress
* Sabine Neumeyer's cKPFM code
* Josh Agar's convex hull code
* Iaroslav Gaponenko's Distort correct code from - https://github.com/paruch-group/distortcorrect.
* Port everything from IFIM Matlab -> Python translation exercises
* Other workflows/functions that already exist as scripts or notebooks
......@@ -29,15 +34,12 @@ Short tutorials on how to use pycroscopy
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
* Access h5 files
* Find a specific dataset/group in the file
* Select data within a dataset in various ways - effectively just examples of hdf_utils functions
* Slicing and dicing multidimensional datasets
* Select data within a dataset in various ways
* micro datasets / microdata groups
* position and spectroscopic datasets with multidimensional datasets
* chunking the main dataset
* Setting up interactive visualizers
* Links to tutorials on how to use pycharm, Git,
Longer examples (probably scientific workflows / pipelines)
Longer examples (via specific scientific usecases)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Done:
......@@ -53,6 +55,8 @@ Done:
Pending:
* How to write your own analysis class
* A tour of the many functions in hdf_utils and io_utils since these functions need data to show / explain them.
* pycroscopy pacakge organization - a short writeup on what is where and differences between the process / analyis submodules
Rama's (older and more applied / specific) tutorial goals
~~~~~~~~~~~~~~~~~~~~
......
Supports Markdown
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