Closed zaneselvans closed 4 years ago
All of the projects have been split off into their own repositories, but there are still some bits to deal with. Are there any useful tools in notebook form hanging out in these directories:
notebooks/ferc1
notebooks/eia923
This one has stuff that's current/ongoing:notebooks/work-in-progress
And then there are a few interesting notebooks that maybe we want to work into the validation / dataviz, or that are associated with the BGA blog post:notebooks/bga-explained.ipynb
notebooks/ferc_to_eia_plant_correlations.ipynb
notebooks/mcoe_model_inputs.ipynb
A lot of what we have checked into the repository really isn't part of the library we are distributing. The main mess of a directory is
results
-- almost everything in there uses PUDL but isn't really part of PUDL.There are also some development tools in there that we probably want to keep track of -- especially the notebooks etc. that help us do the somewhat manual mapping of IDs for plants and utilities in FERC and EIA. So maybe in lieu of the
scripts
and residualresults
content, we can make adevtools
directory.Directories to keep:
src/pudl
(the package itself).docs
(documentation).scripts
(really there's just one script left here -- that generates test data for PyTest to use)test
(PyTest stuff)Files to keep:
README.rst
(by convention, kept in the top level directory)LICENSE.txt
(by convention, kept in the top level directory)environment.yml
(should probably become part ofdevtools
)pyproject.toml
(which will absorbtox.ini
and other tool config files, see #361)tox.ini
and other tool config files (for now) most of which are hidden dotfiles.MANIFEST.in
(for use by setuptools -- will this go inpyproject.toml
too?)setup.py
(for use by setuptools -- will this go inpyproject.toml
too?)Project Repos to maybe split off:
msha-datapkg
wind-ppa-mcoe
manual-mcoe
ef-natural-gas
fossil-refi
ferc1-mcoe-animation