add more documentation for v0.2.7 #66
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
mikofski
commented
Oct 6, 2016
mikofski
commented
- finish tutorials 3, 4 and 5
- add APIs for data, formulas and scripts
- add newstyle example and update documentation for newstyle
* remove history from readme and just link to github releases page * fix pep8 errors from setup.py
* add announcements
* update pvpower tests with new and old models * add announcement regarding changes to interval and sim_length in simulations class *
* models test wasn't testing model BreakingBytes#1 which specifies parameter path as class attributes * fix typos in docstring for quickstart
* in getting started explain why there are 2 different methods for specifying parameters * get rid of the batch example in tests that was never used * add docstrings to sim test to explain that it tests specifying the sim param file as class attrs
* fix italic format typos, not markdown * add ordered list to parameters section on model styles * fix cross reference name error in tutorial 5
* add Outputs to tutorial title and Outputs Class section after intro * add Outputs Registry section with link to last tutorial and promise for further discussion * change material property example from soiling to degradation, and give power as non-material property. * add model test for no model parameters and check state is "uninitialized"
…s to docs * use argparse in carousel-quickstart script instead of checking sys.argv * fix indent for example code in data_readers.py JSONReader class * add links to model.py module docstring for model->models plural and Model class, also make sentence less wordy * add models and layers modules to core.rst, remove extra spaces and promote Core header up a level * don't autodoc UREG, instead use explicit markup and make a link to Pint documentation * add Carousel JSON Encoder to core.rst too * fix there was no data-sources or data-readers labelsin the docs, but there were references to them, huh? * there were references to non-existing formulas lable too, true! * don't autodoc carousel-quickstart since it can't be imported easily since it uses a hyphen, instead use explicit markup and move the docstring to scripts.rst since the argument parser provides help instead * finish rewrite of tutorial 1: Outputs - finish alternatel parameter file style and examples - add table of calculated output attributes - include timeseries in first attr table - add explaination re: timeseries to constant flag section * add more detail re: quickstart in getting started about the PROJ_PATH constant in the project package __init__.py file and links to API
* also update getting started references to PVLIB * also explain that example is in repo and sdist
* also remove the TODO in FormulaBase about converting methods in the formulas class to either static methods or whatever. This question was closed in issue # 65 * fix wordy sentence and typos in getting started * show full path to Output class in tutorial 1, remove extra spaces from fancy format table * change "resize outptus for output" to "outputs for writing files" * more typos everywhere * add "Calculations" to tutorial 2 title * add calculation attributes section and change `always_calc` to ignores thresholds * move parameter file style to end instead of v.v. Signed-off-by: Mark Mikofski <mark.mikofski@sunpowercorp.com>
* also fix constants not used in DataBase meta class for data_reader and data_cache flags * fix bugs in NumericalExpressionImporter - formulas were not returned! return the formulas! - transpose retval so uncertainty wrapper knows how many observations there are! * pop formula_importer from attr in FormulaBase so it can be overwritten in subclass * start section on formula attributes in tutorial 3, and add :: markup for code examples * new test also checks that uncertainty and jacobian or correct, even for multiple observations
* add attributes section to tutorial-3 * fix don't need trailing None for input data args, oops! * reshape output for formulas in test_sim
* always check if formulas are already imported or on python path * add details to formulas tutorial about specifying module, package and path
* always check if formulas are already imported or on python path * add details to formulas tutorial about specifying module, package and path
* always check if formulas are already imported or on python path * add details to formulas tutorial about specifying module, package and path
* always check if formulas are already imported or on python path * add details to formulas tutorial about specifying module, package and path
* complete data source attributes section, including data reader and enable cache * add data reader section * add simulation class example, attributes section * add model class example and demo of running model simulation * demo how to retrieve registry data
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.