Metadata-Version: 2.1
Name: simago
Version: 0.3.1
Summary: Randomly generate populations.
Home-page: https://github.com/alexanderharms/simago
Author: Alexander Harms
Author-email: a.g.j.harms@protonmail.com
Maintainer: Alexander Harms
Maintainer-email: a.g.j.harms@protonmail.com
License: GPL v3
Project-URL: Documentation, https://simago.readthedocs.io/en/latest
Project-URL: Source Code, https://github.com/alexanderharms/simago/
Description: Simago: Population simulation
        =============================
        
        .. title-string
        
        .. image:: https://github.com/alexanderharms/Simago/workflows/CI/badge.svg?branch=master
            :target: https://github.com/alexanderharms/Simago/actions?workflow=CI
            :alt: CI Status
        
        .. image:: https://readthedocs.org/projects/simago/badge/?version=latest
            :target: https://simago.readthedocs.io/en/latest/?badge=latest
            :alt: Documentation Status
        
        This package can be used to generate random populations, sets of microdata, based
        on (publicly availabled) aggregated data.
        
        These populations can then for example be used for experimentation in the field
        of machine learning or simulation studies.
        
        The ``simago`` package is available on `PyPI <https://pypi.org/project/simago/>`_,
        the source code on `Github <https://github.com/alexanderharms/Simago>`_ and
        the documentation on `ReadTheDocs <https://simago.readthedocs.io/en/latest/>`_.
        The package is released under the GPLv3 licence and tested for Python 3.7 and up.
        
        See the changes in the `changelog <https://simago.readthedocs.io/en/latest/changelog>`_.
        
        Usage
        -----
        The easiest way to get started, after installing the package with ``pip install simago``,
        is to use the function ``generate_population()`` from ``simago.population``.
        This function creates an instance of the ``PopulationClass`` object with
        the generated population Pandas DataFrame as the ``PopulationClass.population``
        attribute.
        
        The population DataFrame contains a row for every person and a column for each
        property. The values for these properties are randomly drawn from probability
        distributions defined by the supplied data. This is done by supplying a
        settings (YAML) file, a data (CSV) file and possibly a conditions (CSV) file.
        For more guidance see the `example <https://simago.readthedocs.io/en/latest/example.html>`_
        in the documentation.
        
        How to contribute
        ^^^^^^^^^^^^^^^^^
        If you would like to contribute to this project, please check out the
        `contributing guidelines <https://simago.readthedocs.io/en/latest/contributing.html>`_.
        
        .. end-general-intro
        
Keywords: simulation,open data
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Natural Language :: English
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Scientific/Engineering
Description-Content-Type: text/x-rst
