Metadata-Version: 2.1
Name: fdi
Version: 1.0.6
Summary: Flexible Data Integrator
Home-page: http://mercury.bao.ac.cn:9006/mh/fdi
Author: Maohai Huang
Author-email: mhuang@earth.bao.ac.cn
License: LGPL v3
Description: Flexible Dataset Integrator (FDI) helps data producers and processors to build connections into isolated heterogeneous datasets. to assemble, organize, and integrate data into self-describing, modular, hierarchical, persistent, referenceable ``Products``, whose component datasets keep their own characteristicss and are easily accessible.
        
        FDI provides scripting-friendly  APIs  and 
        tools to define custom Products and generating Python class files. An integrated Product takes care of inter-platform compatibility, string representation, serialisation to simple exchange format, persistence to disk or server, and carrying references of other Products, enabling context-building and lazy-loading.
        
        FDI's base data model is defined in sub-package ``dataset``. Persistent data
        access using storage pools, referencing, and Universal Resource Names, and referencie-carrying product Context, are defined in sub-package ``pal``. A reference RESTful API server designed to communicate with a data processing server/docker using the data model, and a reference HTTP pool server are in sub-package ``pns``.
        
        Install/Uninstall
        -----------------
        
        .. tip::
        
           It is a good idea to add ``--user`` at the end or to use a virtualenv to avoid disturbing your system Python setup.
        
        For Users
        =========
        
        To install from PyPI:
        
        .. code-block:: shell
        
           python3 -m pip install fdi
        
        or from git repo:
        
        .. code-block:: shell
        
           python3 -m pip install http://mercury.bao.ac.cn:9006/mh/fdi/-/archive/master/fdi-master.tar.gz
        
        If you want to install the ``develop`` branch with dependencies:
        
        .. code-block:: shell
        
           python3 -m pip install fdi[DEV]
           
        or
        
        .. code-block:: shell
        
           python3 -m pip install http://mercury.bao.ac.cn:9006/mh/fdi/-/archive/develop/fdi-develop.tar.gz#egg=fdi[DEV]
           
        To uninstall:
        
        .. code-block:: shell
        
                   python3 -m pip uninstall fdi
        
        
        For Developers and Admins (or Those who are Not Sure which to Choose)
        =====================================================================
        
        To install
        ----------
        
        .. code-block:: shell
        
                   FDIINSTDIR=/tmp   # change this to your installation dir
                   cd $FDIINSTDIR
                   git clone ssh://git@mercury.bao.ac.cn:9005/mh/fdi.git@develop
                   cd fdi
                   python3 -m pip install -e .[DEV]
        	   git checkout develop
        	   
        If you want to install the ``master`` branch, remove the ``@develop`` part and the last line above.
        	   
        To test your installation
        -------------------------
        
        .. code-block:: shell
        
                   make test
        
        .. tip::
        
           To pass command-line arguments to ``pytest`` do, for example,
           
           .. code-block:: shell
        		   
        		make test T='-k Bas'
        
           to test ``BaseProduct``.
        
        
        To Generate Python Product Source Code
        --------------------------------------
        
        Re-generate ``baseproduct.py`` and ``product.py`` from YAML schema files in
        ``fdi/dataset/resources``:
        
        .. code-block:: shell
        
                   make py
        
        
        Modify/Generate Documents
        -------------------------
        
        If you plan to compile documents in the ``docs`` directory, generate diagrams, API files, or HTML pages, run (in that order, respectively):
        
        .. code-block:: shell
        
                   make docs_plots
                   make docs_api
                   make docs_html
        
        The generated HTML page is at ``docs/html/index.html``.
        
        .. note:: https://readthedocs.io makes web pages from sources in ``docs/sphinx`` in the repository. Locally generated HTML pages are not on RTD or in the repository. The API files and plots, however, are in ``api`` and ``_static`` sub-directpries, respectively.
        	   
        Run Servers
        -----------
        
        If you plan to run the ``pns`` and/or the http pool server locally,
        install the dependencies:
        
        .. code-block:: shell
        
                   python3 -m pip install -e .[SERV]
        	   make installpns
        
        To test your ``pns`` servers installation, in one window, run:
        
        .. code-block:: shell
        
                   make runserver
        
        in another window run:
        
        .. code-block:: shell
        
                   make testpns
        
        To test your ``httppool`` servers installation, in one window, run:
        
        .. code-block:: shell
        
                   make runpoolserver
        
        in another window run:
        
        .. code-block:: shell
        
                   make testhttppool
        
        For More
        --------
        
        For more  examples see ``tests/test_*.py``.
        
        Read more on package introduction, description, quick start, and API
        documents on `readthedocs.io <https://fdi.readthedocs.io/en/latest/>`__.
        
        
Keywords: dataset metadata processing product context serialization server URN RESTful API HCSS
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Classifier: Framework :: Flask
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU Lesser General Public License v3 (LGPLv3)
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Provides-Extra: DEV
Provides-Extra: SERV
