Package: impax
=====impax=====.. image:: https://img.shields.io/pypi/v/impax.svg:target: https://pypi.python.org/pypi/impax.. image:: https://img.shields.io/travis/ClimateImpactLab/impax.svg:target: https://travis-ci.org/ClimateImpactLab/impax.. image:: https://readthedocs.org/projects/impax/badge/?version=latest:target: https://impax.readthedocs.io/en/latest/?badge=latest:alt: Documentation Status.. image:: https://pyup.io/repos/github/ClimateImpactLab/impax/shield.svg:target: https://pyup.io/repos/github/ClimateImpactLab/impax/:alt: UpdatesImpact Forecasting for the Climate Impact Lab* Free software: MIT license* Documentation: https://impax.readthedocs.io.Setting up this package-----------------------*Justin Simcock: complete these instructions and then remove this section fromthe readme.*1.  Create a matching repository on github if you haven't already:a.  go to https://github.com/organizations/ClimateImpactLab/repositories/newb.  enter the following information:ownerClimateImpactLabRepository NameimpaxDescriptionImpact Forecasting for the Climate Impact LabPrivacyPublic**Do not initialize the repo with a readme, license, or gitignore!**c.  Press the big green buttton2.  Execute the following commands in this directory:.. code-block:: bashgit initgit add .git commit -m "initial commit"git remote add origin git@github.com:ClimateImpactLab/impax.gitgit push -u origin master3.  Set up automated testing, coverage, updates, and docs:a.  Set up testingi.      go to https://travis-ci.org/ and sign in/sign up with github.Make sure travis has access to the repositories on your githubaccount *and* those owned by the ClimateImpactLab by enablingaccess in your account settings.ii.     Next to "My Repositories" click the '+' iconiii.    Flip the switch on ClimateImpactLab/impax. Ifyou don't see it in the list, click 'Sync account', and makesure you are looking at the ClimateImpactLab repositories.iv.     Push a change to your package (for example, you could deletethis section). You should see tests start running on travisautomatically.v.      Start writing tests for your code in the``impax/tests`` folder. There are someexamples already in there to get you started.b.  Set up docsi.      go to https://readthedocs.io and sign in/sign up with github.Same deal - make sure readthedocs has access to your githubaccount and ClimateImpactLab.ii.     click 'Import a project', go to ClimateImpactLab, and refresh.iii.    click the '+' icon next toClimateImpactLab/impax. Pick a name for yourproject. The name has to be globally unique (not just withinthe ClimateImpactLab), so if you chose something with a commonname you may have to rename the docs.iv.     go to the settings page for your new docs site, and navigate to the 'advanced settings' tab.add `requirements_rtd.txt` to the "requirements file" field.v.      next time you push code to master, docs should buildautomatically. You can view them athttps://impax.readthedocs.io/en/latest/(substitute whatever name you chose).c.  Set up updatesi.      go to https://pyup.io. you know the drill.ii.     Go to your account, and click '+ Add Repo'. Sync.iii.    Add ClimateImpactLab/impaxwith "Dependency Updates" and "SafetyCI" turned on. Leave"Update Schedules" off.d.  Set up test coverage monitoringi.      next up: https://coveralls.io. you got this.e.  Breathe easy. The next time you push code, these should all update foryou! Now that wasn't so bad, was it?4.  Develop with github:a.  In general, it's best to file an issue when you want to change somethingor when you've found a bug, then write tests which test a-prioriassertions about desired behavior, and then write the minimum amount ofcode required to pass these tests. See the contributing docs for moreworkflow suggestions.To run all tests on your local machine:.. code-block:: bashmake test5.  Deploya.  Set up deployment by registering the package on the python package index(PyPI):i.      Create an account on PyPI: https://pypi.python.org/pypiii.     Register the package:.. code-block:: bashpython setup.py registeriii.    Encrypt & package your credentials so travis can deploy for you:.. code-block:: bashpython travis_pypi_setup.pyb.  When you're ready to deploy this package, make sure all your changes arecommitted. Then run:.. code-block:: bashbumpversion patch # (or minor or major)git pushgit push --tagsAs soon as this new tagged commit passes tests, travis will deploy foryouc.  Anyone (in the world) should now be able to install your package with.. code-block:: bashpip install [package-name]Features--------* TODOCredits---------This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template... _Cookiecutter: https://github.com/audreyr/cookiecutter.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage=======History=======0.1.2 (Current version)-----------------------API changes~~~~~~~~~~~* :py:func:`impax.csvv.get_gammas` has been deprecated. Use :py:func:`impax.read_csvv` instead (:issue:`37`)* :py:meth:`~impax.csvv.Gammas._prep_gammas` has been removed, and :py:meth:`~impax.csvv.Gammas.sample` nowtakes no arguments and returns a sample by default. Seeding the random number generator is now left up tothe user (:issue:`36`)Bug fixes~~~~~~~~~* fix py3k compatability issues (:issue:`39`)* fix travis status icon in README* add tests for :py:func:`impax.mins._minimize_polynomial`, fix major math errors causing a failure to find minima in :py:mod:`impax.mins` module, and clarify documentation (:issue:`58`)0.1.0 (2017-10-12)------------------* First release on PyPI.