Skip to content

Commit

Permalink
getting ready to deploy on pypi and zenodo
Browse files Browse the repository at this point in the history
  • Loading branch information
FDonati committed Nov 21, 2018
1 parent db326e9 commit fd32e59
Show file tree
Hide file tree
Showing 84 changed files with 1,076 additions and 825 deletions.
24 changes: 12 additions & 12 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Types of Contributions
Report Bugs
~~~~~~~~~~~

Report bugs at https://github.com/FDonati/pyce/issues.
Report bugs at https://github.com/FDonati/pycirk/issues.

If you are reporting a bug, please include:

Expand All @@ -38,14 +38,14 @@ and "help wanted" is open to whoever wants to implement it.
Write Documentation
~~~~~~~~~~~~~~~~~~~

pyCE could always use more documentation, whether as part of the
official pyCE docs, in docstrings, or even on the web in blog posts,
pycirk could always use more documentation, whether as part of the
official pycirk docs, in docstrings, or even on the web in blog posts,
articles, and such.

Submit Feedback
~~~~~~~~~~~~~~~

The best way to send feedback is to file an issue at https://github.com/FDonati/pyce/issues.
The best way to send feedback is to file an issue at https://github.com/FDonati/pycirk/issues.

If you are proposing a feature:

Expand All @@ -57,17 +57,17 @@ If you are proposing a feature:
Get Started!
------------

Ready to contribute? Here's how to set up `pyce` for local development.
Ready to contribute? Here's how to set up `pycirk` for local development.

1. Fork the `pyce` repo on GitHub.
1. Fork the `pycirk` repo on GitHub.
2. Clone your fork locally::

$ git clone [email protected]:your_name_here/pyce.git
$ git clone [email protected]:your_name_here/pycirk.git

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development::

$ mkvirtualenv pyce
$ cd pyce/
$ mkvirtualenv pycirk
$ cd pycirk/
$ python setup.py develop

4. Create a branch for local development::
Expand All @@ -79,7 +79,7 @@ Ready to contribute? Here's how to set up `pyce` for local development.
5. When you're done making changes, check that your changes pass flake8 and the
tests, including testing other Python versions with tox::

$ flake8 pyce tests
$ flake8 pycirk tests
$ python setup.py test or py.test
$ tox

Expand All @@ -103,15 +103,15 @@ Before you submit a pull request, check that it meets these guidelines:
your new functionality into a function with a docstring, and add the
feature to the list in README.rst.
3. The pull request should work for Python 2.7, 3.4, 3.5 and 3.6, and for PyPy. Check
https://travis-ci.org/FDonati/pyce/pull_requests
https://travis-ci.org/FDonati/pycirk/pull_requests
and make sure that the tests pass for all supported Python versions.

Tips
----

To run a subset of tests::

$ py.test tests.test_pyce
$ py.test tests.test_pycirk


Deploying
Expand Down
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ include LICENSE
include README.rst

recursive-include tests *
recursive-include pyce *
recursive-include pycirk *
recursive-exclude * __pycache__
recursive-exclude * *.py[co]

Expand Down
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ coverage: ## check code coverage quickly with the default Python
docs: ## generate Sphinx HTML documentation, including API docs
rm -f docs/pyce.rst
rm -f docs/modules.rst
sphinx-apidoc -o docs/ pyce
sphinx-apidoc -o docs/ pycirk
$(MAKE) -C docs clean
$(MAKE) -C docs html
$(BROWSER) docs/_build/html/index.html
Expand Down
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
# pyce
# pycirk

_A software to model Circular Economy policy and technological interventions in Environmentally Extended Input-Output Analysis starting from SUTs (EXIOBASE V3.3)_

[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](resources/docs/CONTRIBUTING.md)

Documentation: https://bitbucket.org/CML-IE/pyce/src/master/
Documentation: https://bitbucket.org/CML-IE/pycirk/src/master/

## Installation

### Stable release

Run in your terminal:

$ pip install pyce # currently not uploaded to PyPI. It will be there by the end of July 20148
$ pip install pycirk # currently not uploaded to PyPI. It will be there by the end of July 20148

### From source

Clone repository:

$ git clone https://[email protected]/CML-IE/pyce.git
$ git clone https://[email protected]/CML-IE/pycirk.git
or

$ git clone https://github.com/CMLPlatform/pyce.git
$ git clone https://github.com/CMLPlatform/pycirk.git


Once you have a copy of the source, you can install it with:
Expand All @@ -34,11 +34,11 @@ Once you have a copy of the source, you can install it with:

### Import package

import pyce
import pycirk

### Initialize

s = pyce.Start(method, directory, aggregation, make_secondary)
s = pycirk.Start(method, directory, aggregation, make_secondary)

### set your scenarios and analysis

Expand Down Expand Up @@ -75,11 +75,11 @@ Save your entire project

### Use from command line

pyce --help
pycirk --help

Usage: pyce [OPTIONS]
Usage: pycirk [OPTIONS]

Console script for pyce. A software to model policy and technological
Console script for pycirk. A software to model policy and technological
interventions in Environmentally Extended Input-Output Analysis (EXIOBASE
V3.3, 2011)

Expand All @@ -96,7 +96,7 @@ Options:

Command example

pyce -tm 0 -dr "" -sc "all" -s "all"
pycirk -tm 0 -dr "" -sc "all" -s "all"



Expand Down Expand Up @@ -135,7 +135,7 @@ It is possible to specify:
## Important modules


### pyce.py
### pycirk.py

1. Initiates the operations to set scenarios and to create IOT from SUT based on prodxprod Industry-Technology assumption both under Market Share Coefficient method and Technical Coefficient method.
2. From start you can launch all the analysis specifications listed under scenarios.xls and save everything
Expand Down
22 changes: 11 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
####
pyce
pycirk
####


Expand All @@ -9,7 +9,7 @@ pyce
[![License: GPL v3](https://img.shields.io/badge/License-GPL%20v3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg)](resources/docs/CONTRIBUTING.md)

| Documentation: https://bitbucket.org/CML-IE/pyce/src/master/
| Documentation: https://bitbucket.org/CML-IE/pycirk/src/master/


Expand All @@ -23,15 +23,15 @@ pyce

Run in your terminal:0

$ pip install pyce
$ pip install pycirk


1.2. From source
----------------

Clone repository:

$ git clone https://[email protected]/CML-IE/pyce.git
$ git clone https://[email protected]/CML-IE/pycirk.git

Once you have a copy of the source, you can install it with:

Expand All @@ -45,13 +45,13 @@ Once you have a copy of the source, you can install it with:
2.1. Import package
-------------------

import pyce
import pycirk


2.2. Initialize
---------------

s = pyce.Start(method, directory, aggregation)
s = pycirk.Start(method, directory, aggregation)


2.3. set your scenarios and analysis
Expand Down Expand Up @@ -97,11 +97,11 @@ Once you have a copy of the source, you can install it with:

2.6. Use from command line

2.6.1. pyce --help
2.6.1. pycirk --help

Usage: pyce [OPTIONS]
Usage: pycirk [OPTIONS]

Console script for pyce. A software to model policy and technological
Console script for pycirk. A software to model policy and technological
interventions in Environmentally Extended Input-Output Analysis (EXIOBASE
V3.3, 2011)

Expand All @@ -123,7 +123,7 @@ Options:

2.6.2. Command example

pyce -tm 0 -dr "" -sc "all" -s "all"
pycirk -tm 0 -dr "" -sc "all" -s "all"



Expand Down Expand Up @@ -167,7 +167,7 @@ It is possible to specify:
====================


4.1. pyce.py
4.1. pycirk.py
------------


Expand Down
Loading

0 comments on commit fd32e59

Please sign in to comment.