Merge pull request #101 from ECSIM/develop

Version 1.0

.coveragerc

@@ -0,0 +1,5 @@
+[run]
+omit =
+    */opem/__main__.py
+    */opem/__init__.py
+	*/opem/Profile.py

.gitattributes

@@ -0,0 +1 @@
+Documents/* linguist-vendored

.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at opem@ecsim.ir. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

.github/CONTRIBUTING.md

@@ -0,0 +1,17 @@
+## Contribution			
+
+Changes and improvements are more than welcome! ❤️ Feel free to fork and open a pull request.		
+
+
+Please consider the following :
+
+
+1. Fork it!
+2. Create your feature branch (under `develop` branch)
+3. Add your functions/methods to proper files
+4. Add standard `docstring` to your functions/methods
+5. Add tests for your functions/methods (`doctest` testcases in `Test` folder)
+6. Pass all CI tests
+7. Update `CHANGELOG.md`
+	- Describe changes under `[Unreleased]` section
+8. Submit a pull request into `develop` (please complete the pull request template)

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,13 @@
+#### Description
+
+#### Steps/Code to Reproduce
+
+#### Expected Behavior
+
+#### Actual Behavior
+
+#### Operating System
+
+#### Python Version
+
+#### OPEM Version

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+#### Reference Issues/PRs
+
+#### What does this implement/fix? Explain your changes.
+
+
+#### Any other comments?
+

.pyup.yml

@@ -0,0 +1,5 @@
+update: all
+
+branch: develop
+
+schedule: "every week"

.travis.yml

@@ -1,17 +1,29 @@
-sudo: true
-
 language: python
 
-python:
-  - 3.6
-  - 3.5
-  - 3.4
+matrix:
+    include:
+        - os: linux
+          python: 3.7
+          env: TOXENV=py37-linux
+          dist: xenial
+
+        - os: linux
+          python: 3.6
+          env: TOXENV=py36-linux
+
+        - os: linux
+          python: 3.5
+          env: TOXENV=py35-linux
+
+        - os: linux
+          python: 3.4
+          env: TOXENV=py34-linux
+
+install: 
+  - bash .travis/install.sh
 
-install:
-  - pip install -r requirements.txt
-  - python setup.py install
+script: 
+  - bash .travis/test.sh
 
-script:
-  - python -m pytest opem/Test --cov=opem --cov-report=term
 after_success:
-  - codecov
+  - codecov

.travis/install.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+set -e
+set -x
+
+pip install -r requirements.txt
+python setup.py install

.travis/test.sh

@@ -0,0 +1,12 @@
+#!/bin/bash
+# Dump Environment (so that we can check PATH, UT_FLAGS, etc.)
+set -e
+set -x
+
+python -m opem test
+pip install -r dev-requirements.txt
+python version_check.py
+python -m bandit -r opem -s B322
+python -m vulture --min-confidence 80 --exclude=opem,build,.eggs --sort-by-size .
+python -m pytest opem/Test --cov=opem --cov-report=term
+python -m cProfile -s cumtime opem/Profile.py

CHANGELOG.md

@@ -5,116 +5,139 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+## [1.0] - 2019-03-01
+### Added
+- Interactive notebooks section
+- `version_check.py`
+- `CODE_OF_CONDUCT.md`
+- `ISSUE_TEMPLATE.md`
+- `PULL_REQUEST_TEMPLATE.md`
+- `build_exe.bat`
+- `build_unix.sh`
+- Anaconda cloud package
+
+### Changed
+- Document modified
+- Test system modified
+- `README.md` modified
+- `dev-requirements.txt` modified
+- `requirements.txt` modified
+- `CONTRIBUTING.md` modified
+- `linear_plot` function bug fixed
+- `INSTALL.md` modified
+
+
 ## [0.9] - 2018-07-14
 ### Added
 - JOSS paper
 
 ### Changed
-- Test System Updated
-- setup File Modified
-- Exceptions Modified
+- Test system updated
+- `setup.py` file modified
+- Exceptions modified
 
 ### Removed
 - `PEM.md`
 
 ## [0.8] - 2018-04-10
 ### Added
-- Overall Parameters
-- Linear Approximation
-- Power(Thermal) Parameter
-- Efficiency vs I Plot
-- PH2 vs I Plot
-- PO2 vs I Plot
-- Power vs Efficiency Plot
-- Loss vs I Plot
-- Power(Thermal) vs I Plot
-- macOS Version
+- Overall parameters
+- Linear approximation
+- Thermal power parameter
+- Efficiency vs I plot
+- PH2 vs I plot
+- PO2 vs I plot
+- Power vs Efficiency plot
+- Loss vs I plot
+- Power-Thermal vs I plot
+- macOS version
 
 ### Changed
-- Simulation Error Response
+- Simulation error response
 
 ## [0.7] - 2018-03-17
 ### Added
-- Standard Test Vectors
-- Model Description
-- Help Page
-- Warning System
-- System Block Diagram
+- Standard test vectors
+- Model description
+- Help page
+- Warning system
+- System block diagram
 
 ### Changed
-- HTML Report Layout
+- HTML report layout
 
 ## [0.6] - 2018-03-1
 ### Added
-- Padulles-Amphlett Dynamic Model
-- Check Update Function
-- Webpage Document Section
+- Padulles-Amphlett dynamic model
+- `check_update` function
+- Webpage document section
 
 ### Changed
-- Get_Input Function Default Params
-- Exe-File Incompatibility Fixed
+- `Get_Input` function default params
+- Exe-File incompatibility fixed
 
 
 ## [0.5] - 2018-02-16
 ### Added
-- Padulles-Hauer Dynamic Model
-- Simulation Name
-- Interactive HTML Report
+- Padulles-Hauer dynamic model
+- Simulation name
+- Interactive HTML report
 ### Changed
-- qH2O And qH2 In Padulles Dynamic Model 2 Merged
-- Static Analysis Function Output
-- Dynamic Analysis Function Output
-- ReportMode & PrintMode Flags
+- qH2O and qH2 in Padulles dynamic model 2 merged
+- `Static_Analysis` function output
+- `Dynamic_Analysis` function output
+- `ReportMode` & `PrintMode` flags
 
 ## [0.4] - 2018-02-06
 ### Added
-- Test Case Of Padullas Model 2
-- Padulles Dynamic Model 2
+- Test case of Padulles model 2
+- Padulles dynamic model 2
 
 
 ### Changed
-- Travis And Appveyor Configs
-- Jupyter Notebook Documentation
+- Travis and Appveyor configs
+- Jupyter notebook documentation
 
 ### Removed
-- RHO In Larmninee Model
+- RHO in Larmninee model
 
 ## [0.3] - 2018-01-31
 ### Added
-- Padulles Dynamic Model 1
-- GUI Folder
+- Padulles dynamic model 1
+- GUI folder
 
 
 ### Changed
-- Test Cases For Static Models
-- Padullas Refactored
-- Jupyter Notebook Padullas
+- Test cases for static models
+- Padulles refactored
+- Jupyter notebook Padulles
 
 ## [0.2] - 2018-01-05
 ### Added
-- Test Case And CI
-- Jupyter Notebook And Documentation
-- exe-version
+- Test case and CI
+- Jupyter notebook and documentation
+- Exe-Version
 - Badges
-- Larminie-Dicks Static Model
-- Chamberline-Kim Static Model
-- pyqt5 To Requirments
+- Larminie-Dicks static model
+- Chamberline-Kim static model
+- pyqt5 to requirments
 
 ### Removed
-- python2.7 Setup For pyQt
+- python2.7 setup for pyqt
 
 ### Changed
- - Style To PEP8
- - Power Stack
+ - Style to PEP8
+ - Stack power
 
 ## [0.1] - 2017-12-25
 ### Added
-- Static Analyze Prototype
-- Amphlett Analyze
-- CSV Output Files
-- Documents And README
+- `Static_Analyze` prototype
+- Amphlett analyze
+- CSV output files
+- Documents and `README.md`
 
-[Unreleased]: https://github.com/ECSIM/opem/compare/v0.9...HEAD
+[Unreleased]: https://github.com/ECSIM/opem/compare/v1.0...develop
+[1.0]: https://github.com/ECSIM/opem/compare/v0.9...v1.0
 [0.9]: https://github.com/ECSIM/opem/compare/v0.8...v0.9
 [0.8]: https://github.com/ECSIM/opem/compare/v0.7...v0.8
 [0.7]: https://github.com/ECSIM/opem/compare/v0.6...v0.7