Skip to main content

Network propagation models for networkx.

Project description

experinet
#######
.. |PyPI-Status| |PyPI-Versions| |Build-Status| |Codecov| |LICENCE|

.. .. |experinet_icon| image:: https://github.com/shaypal5/experinet/blob/88d480fd90820ea58c062029ce7e926201794e47/experinet_small.png

Synthetic network theory experiment.

.. code-block:: python

experinet.run_experiment(
{
'entry': {
'type': 'generate',
'model': 'ba',
'd': 2,
}
}
)

.. contents::

.. section-numbering::


Installation
============

.. code-block:: bash

pip install experinet



Features
========

* Pure python.
* Supports Python 3.5+.
* Fully tested.


Use
===

TBA


Contributing
============

Package author and maintainer is Shay Palachy (shay.palachy@gmail.com); You are more than welcome to approach him for help. Contributions are very welcomed.

Installing for development
----------------------------

Clone:

.. code-block:: bash

git clone git@github.com:shaypal5/experinet.git


Install in development mode, including test dependencies:

.. code-block:: bash

cd experinet
pip install -e '.[test]'



Running the tests
-----------------

To run the tests use:

.. code-block:: bash

cd experinet
pytest


Adding documentation
--------------------

The project is documented using the `numpy docstring conventions`_, which were chosen as they are perhaps the most widely-spread conventions that are both supported by common tools such as Sphinx and result in human-readable docstrings. When documenting code you add to this project, follow `these conventions`_.

.. _`numpy docstring conventions`: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
.. _`these conventions`: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt

Additionally, if you update this ``README.rst`` file, use ``python setup.py checkdocs`` to validate it compiles.


Credits
=======

Created by Shay Palachy (shay.palachy@gmail.com).


.. |PyPI-Status| image:: https://img.shields.io/pypi/v/experinet.svg
:target: https://pypi.python.org/pypi/experinet

.. |PyPI-Versions| image:: https://img.shields.io/pypi/pyversions/experinet.svg
:target: https://pypi.python.org/pypi/experinet

.. |Build-Status| image:: https://travis-ci.org/shaypal5/experinet.svg?branch=master
:target: https://travis-ci.org/shaypal5/experinet

.. |LICENCE| image:: https://github.com/shaypal5/experinet/blob/master/mit_license_badge.svg
:target: https://github.com/shaypal5/experinet/blob/master/LICENSE

.. https://img.shields.io/github/license/shaypal5/experinet.svg

.. |Codecov| image:: https://codecov.io/github/shaypal5/experinet/coverage.svg?branch=master
:target: https://codecov.io/github/shaypal5/experinet?branch=master


Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

experinet-0.0.0-py2.py3-none-any.whl (5.3 kB view details)

Uploaded Python 2Python 3

File details

Details for the file experinet-0.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for experinet-0.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 708fcb1f2ab9261f9f3b3002e0b313d5d831bd8eaebefff7bb698955f5af9201
MD5 9f0ede59146826e58383877291e09291
BLAKE2b-256 88b67696bb4111517e70be80161c533cdb8b66a9decd55bb632cd6cb5e4d2e57

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page