Skip to content

Commit

Permalink
Implementing Logging Configuration for Notebook Logging (tardis-sn#1633)
Browse files Browse the repository at this point in the history
* Implementing Logging Configuration for Notebook Logging via Function

* Adding Docstring to logging_state()

* Making logging states independent of case of arugment passed

* Adding Debug YAML for Logging & Debugging

* Changing implementation to a single unified flag for logging level

* Moved logging_state() from montecarlo_logger to __init__ for TARDIS

* Adding support for logging messages at specified level

* Moving check for yaml & functional argument to logging_state function

* Added functionality for the Debug section of the YAML to be optional
Implemented check for Logging level & displaying Dataframe appropriately

* Added Tests for logging output configuration via Functional Input & YAML File
Added new YAML test file for testing YAML arguments for logging configuation

* Fixed display() still showing the plasma stratification values table when using specific logging at other logging levels than INFO

* Reworded description of the specific_logging parameter in debug.yml

* Added tests for simulation when both parameters, functional & YAML, are present
Changed debug.yml to be consistent with other test YAML configurations

* Changed the number of iterations & test cases for faster test executions

* Fixed docstring in __init__.py to impart the current implementation of the logging_state func

* Restructuring tests for faster simulation runs

* Added Tutorial Documentation for logging configuration

* Fixed & reworded some explaination in the Tutorial for better understanding

* Changed Quickstart notebook to incorporate new logging config in run_tardis()

* Changed the notebook as request, grammer changes

* Changed the python version to 3.7.10, reran the notebooks

* Fixed some inconsistencies in tutorial grammar

* Fixed with requested changes

* Made logging_level constant value
Changed the TestSimulationLogging class to comply to PEP8 styling

* Fixed metadata for scroll in quickstart notebook

* Renamed logging_level & specific_logging in debug schema to log_state & specific resp

* Added explaination of list_of_filters
Changed some implementation based on requested changes

* Added raising of an expection when invalid log_state parameter value is passed

* Changed implementation for the log_state function as well as the YAML arguments
Default value now falls to Debug->Log_state variable
Log_state functional parameter has None as default value

* Added message for informing the user which parameter will be used when YAML & Functional parameters are specified
Updated the Documentation for the newer changes

* [build docs]
  • Loading branch information
DhruvSondhi authored Jul 1, 2021
1 parent 5b2607f commit 8b252be
Show file tree
Hide file tree
Showing 11 changed files with 878 additions and 12 deletions.
1 change: 1 addition & 0 deletions docs/io/optional/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ TARDIS also allows other inputs that are passed as arguments into the ``run_tard

custom_source
callback_example
logging_configuration


Additionally, ``run_tardis`` can take in a filepath for the atomic data and a boolian for virtual packet logging, both of
Expand Down
Loading

0 comments on commit 8b252be

Please sign in to comment.