https://github.com/francbartoli/dj-experiment

Django package for experiment
https://github.com/francbartoli/dj-experiment

Last synced: about 1 month ago
JSON representation

Django package for experiment

• Host: GitHub
• URL: https://github.com/francbartoli/dj-experiment
• Owner: francbartoli
• License: mit
• Created: 2017-07-31T12:20:42.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2022-12-26T20:29:12.000Z (almost 2 years ago)
• Last Synced: 2024-09-03T07:52:11.271Z (2 months ago)
• Language: Python
• Size: 72.3 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.rst
  • Changelog: HISTORY.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
=============================

Experiment

=============================

.. image:: https://badge.fury.io/py/dj-experiment.svg

    :target: https://badge.fury.io/py/dj-experiment

.. image:: https://travis-ci.org/francbartoli/dj-experiment.svg?branch=master

    :target: https://travis-ci.org/francbartoli/dj-experiment

.. image:: https://codecov.io/gh/francbartoli/dj-experiment/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/francbartoli/dj-experiment

Django application for organizing numerical model experiment output

Documentation

-------------

The full documentation is at https://dj-experiment.readthedocs.io.

Quickstart

----------

Install Experiment::

    pip install dj-experiment

Add it to your `INSTALLED_APPS`:

.. code-block:: python

    INSTALLED_APPS = (

        ...

        'dj_experiment.apps.DjExperimentConfig',

        ...

    )

Add Experiment's URL patterns:

.. code-block:: python

    from dj_experiment import urls as dj_experiment_urls

    urlpatterns = [

        ...

        url(r'^', include(dj_experiment_urls)),

        ...

    ]

Features

--------

* TODO

Running Tests

-------------

Does the code actually work?

::

    source /bin/activate

    (myenv) $ pip install tox

    (myenv) $ tox

Credits

-------

Tools used in rendering this package:

*  Cookiecutter_

*  `cookiecutter-djangopackage`_

.. _Cookiecutter: https://github.com/audreyr/cookiecutter

.. _`cookiecutter-djangopackage`: https://github.com/pydanny/cookiecutter-djangopackage