Metadata-Version: 2.1
Name: icpmsflow
Version: 0.0.3
Summary: Package to work with icpms data
Home-page: https://github.com/wpk-nist-gov/icpmsflow
Author: William P. Krekelberg
Author-email: wpk@nist.gov
License: NIST license
Keywords: icpmsflow
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: License :: Public Domain
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.6
Requires-Dist: setuptools (>=38.4)
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: openpyxl
Requires-Dist: scipy
Requires-Dist: holoviews
Requires-Dist: bokeh

=========
icpmsflow
=========


.. image:: https://img.shields.io/pypi/v/icpmsflow.svg
        :target: https://pypi.python.org/pypi/icpmsflow

.. image:: https://img.shields.io/travis/wpk-nist-gov/icpmsflow.svg
        :target: https://travis-ci.com/wpk-nist-gov/icpmsflow

.. image:: https://readthedocs.org/projects/icpmsflow/badge/?version=latest
        :target: https://icpmsflow.readthedocs.io/en/latest/?badge=latest
        :alt: Documentation Status




Package to work with icpms data


* Free software: NIST license
* Documentation: https://icpmsflow.readthedocs.io.


Installation
------------

This project is not yet available via conda or on pypi.  The recommended route is to install most dependencies via conda, then pip install directly from github.  For this, do the following:

If you'd like to create an isolated environment:

.. code-block:: console

    $ conda create -n {env-name} python=3.8

Activate the environment you'd like to install to with:

.. code-block:: console

   $ conda activate {env-name}

Install required dependencies with:

.. code-block:: console

   $ conda install -n {env-name} setuptools numpy pandas openpyxl scipy holoviews bokeh jupyter


Note that `jupyter` is not strictly required, but assumed.  You can also use `ipykernel` to just install the kernel for the target environment.


Finally, install `neutron_analysis` in the active environment do:

.. code-block:: console

   $ pip install git+https://github.com/wpk-nist-gov/icpmsflow.git@develop



Example usage
-------------

See demo notebook : `demo <notebooks/example_usage.ipynb>`_

Example dataset : `example <https://github.com/wpk-nist-gov/icpmsflow/blob/develop/notebooks/example.tgz?raw=true>_`


Features
--------

* TODO

Credits
-------

This package was created with Cookiecutter_ and the `wpk-nist-gov/cookiecutter-pypackage`_ Project template forked from `audreyr/cookiecutter-pypackage`_.

.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`wpk-nist-gov/cookiecutter-pypackage`: https://github.com/wpk-nist-gov/cookiecutter-pypackage
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage

=======
History
=======

0.0.1 (2021-04-03)
------------------

* First release on PyPI.

This software was developed by employees of the National Institute of Standards
and Technology (NIST), an agency of the Federal Government. Pursuant to title 17
United States Code Section 105, works of NIST employees are not subject to
copyright protection in the United States and are considered to be in the public
domain. Permission to freely use, copy, modify, and distribute this software and
its documentation without fee is hereby granted, provided that this notice and
disclaimer of warranty appears in all copies.

THE SOFTWARE IS PROVIDED 'AS IS' WITHOUT ANY WARRANTY OF ANY KIND, EITHER
EXPRESSED, IMPLIED, OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY
THAT THE SOFTWARE WILL CONFORM TO SPECIFICATIONS, ANY IMPLIED WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND FREEDOM FROM
INFRINGEMENT, AND ANY WARRANTY THAT THE DOCUMENTATION WILL CONFORM TO THE
SOFTWARE, OR ANY WARRANTY THAT THE SOFTWARE WILL BE ERROR FREE. IN NO EVENT
SHALL NIST BE LIABLE FOR ANY DAMAGES, INCLUDING, BUT NOT LIMITED TO, DIRECT,
INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES, ARISING OUT OF, RESULTING FROM, OR
IN ANY WAY CONNECTED WITH THIS SOFTWARE, WHETHER OR NOT BASED UPON WARRANTY,
CONTRACT, TORT, OR OTHERWISE, WHETHER OR NOT INJURY WAS SUSTAINED BY PERSONS OR
PROPERTY OR OTHERWISE, AND WHETHER OR NOT LOSS WAS SUSTAINED FROM, OR AROSE OUT
OF THE RESULTS OF, OR USE OF, THE SOFTWARE OR SERVICES PROVIDED HEREUNDER.

Distributions of NIST software should also include copyright and licensing
statements of any third-party software that are legally bundled with the code in
compliance with the conditions of those licenses.


