Doxygen #10
Closed
Doxygen #10
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
aaronjridley
approved these changes
Dec 16, 2020
Moved python code to an appropriately named module directory and created an init file.
Created an input-output submodule, reorganizing the Aether and GITM reading routines into read and fetch modules. Also: - fixed PEP8 compliance, - updated docstrings, - added an init file, - removed duplicate code, and - made GITM and Aether outputs more similar.
Created a utils sub-module and moved the time routines into this module.
Created a sub-module for plotting routines.
Removed the old python files and directory.
Updated the copyright and license line in the time_conversion file.
Added a sub-module supporting the processing of command line inputs.
Added an import command for the new inputs module.
Extracted the movie routines from the plot_model_results file into their own sub-module.
Updated plot_model_results to use new sub-modules and header output format.
Added the data_prep module, which currently contains a coordinate slicing routine.
Made PEP8 improvements to variable names and replaced appropriate code with routines from the new data_prep sub-module.
Added a routine to calculate the TEC over a specified altitude range. Also updated the `get_cut_index` routine to return a tuple for slicing data of the expected dimensions.
Used the new TEC calculation routine and removed unnecessary logic loops and variables.
Finished updating the PEP8 changes and renamed the file to indicate that it is a script.
Added `__pycache__` to list of things that git should ignore.
Fixes the bug that ignores files whose name start with `run`.
Adds the default plotting script that was accidentally ignored by git previously.
Removed the old import of the running script that has been moved to the main module directory.
Moved the logger definition to occur before the sub-module imports, so that it is always defined.
Read inputs
Python style update
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.
Description
Addresses #9
Add Doxygen makefile Doxyfile
Type of change
How Has This Been Tested?
Checked generated html output in my web browser
Test configuration
Checklist:
CHANGELOG.md, summarizing the changes