covsirphy package

get_citation()

Return the citation of CovsirPhy

Returns:

str

get_version()

Return the version number, like CovsirPhy v0.0.0

Returns:

str

Subpackages

• covsirphy.downloading package
  • Submodules
  • covsirphy.downloading.downloader module
    • DataDownloader
      • DataDownloader.LAYERS
      • DataDownloader.citations()
      • DataDownloader.layer()
• covsirphy.dynamics package
  • Submodules
  • covsirphy.dynamics.dynamics module
    • Dynamics
      • Dynamics.detect()
      • Dynamics.estimate()
      • Dynamics.estimate_params()
      • Dynamics.estimate_tau()
      • Dynamics.evaluate()
      • Dynamics.from_data()
      • Dynamics.from_sample()
      • Dynamics.model
      • Dynamics.model_name
      • Dynamics.name
      • Dynamics.parse_days()
      • Dynamics.parse_phases()
      • Dynamics.register()
      • Dynamics.segment()
      • Dynamics.simulate()
      • Dynamics.start_dates()
      • Dynamics.summary()
      • Dynamics.tau
      • Dynamics.track()
  • covsirphy.dynamics.ode module
    • ODEModel
      • ODEModel.definitions()
      • ODEModel.dimensional_parameters()
      • ODEModel.from_data()
      • ODEModel.from_data_with_optimization()
      • ODEModel.from_data_with_quantile()
      • ODEModel.from_sample()
      • ODEModel.inverse_transform()
      • ODEModel.name()
      • ODEModel.r0()
      • ODEModel.settings()
      • ODEModel.solve()
      • ODEModel.sr()
      • ODEModel.transform()
  • covsirphy.dynamics.sewirf module
    • SEWIRFModel
      • SEWIRFModel.dimensional_parameters()
      • SEWIRFModel.from_data_with_optimization()
      • SEWIRFModel.from_data_with_quantile()
      • SEWIRFModel.inverse_transform()
      • SEWIRFModel.r0()
      • SEWIRFModel.sr()
      • SEWIRFModel.transform()
  • covsirphy.dynamics.sir module
    • SIRModel
      • SIRModel.dimensional_parameters()
      • SIRModel.inverse_transform()
      • SIRModel.r0()
      • SIRModel.sr()
      • SIRModel.transform()
  • covsirphy.dynamics.sird module
    • SIRDModel
      • SIRDModel.dimensional_parameters()
      • SIRDModel.inverse_transform()
      • SIRDModel.r0()
      • SIRDModel.sr()
      • SIRDModel.transform()
  • covsirphy.dynamics.sirf module
    • SIRFModel
      • SIRFModel.dimensional_parameters()
      • SIRFModel.r0()
      • SIRFModel.sr()
• covsirphy.engineering package
  • Submodules
  • covsirphy.engineering.engineer module
    • DataEngineer
      • DataEngineer.add()
      • DataEngineer.all()
      • DataEngineer.assign()
      • DataEngineer.choropleth()
      • DataEngineer.citations()
      • DataEngineer.clean()
      • DataEngineer.diff()
      • DataEngineer.div()
      • DataEngineer.download()
      • DataEngineer.inverse_transform()
      • DataEngineer.layer()
      • DataEngineer.mul()
      • DataEngineer.recovery_period()
      • DataEngineer.register()
      • DataEngineer.sub()
      • DataEngineer.subset()
      • DataEngineer.subset_alias()
      • DataEngineer.transform()
      • DataEngineer.variables_alias()
• covsirphy.gis package
  • Submodules
  • covsirphy.gis.gis module
    • GIS
      • GIS.all()
      • GIS.area_name()
      • GIS.choropleth()
      • GIS.citations()
      • GIS.layer()
      • GIS.register()
      • GIS.subset()
      • GIS.to_geopandas()
• covsirphy.science package
  • Submodules
  • covsirphy.science.ml module
    • MLEngineer
      • MLEngineer.forecast()
      • MLEngineer.pca()
  • covsirphy.science.ode_scenario module
    • ODEScenario
      • ODEScenario.append()
      • ODEScenario.auto_build()
      • ODEScenario.build_with_dynamics()
      • ODEScenario.build_with_model()
      • ODEScenario.build_with_template()
      • ODEScenario.compare_cases()
      • ODEScenario.compare_param()
      • ODEScenario.delete()
      • ODEScenario.describe()
      • ODEScenario.from_json()
      • ODEScenario.predict()
      • ODEScenario.rename()
      • ODEScenario.represent()
      • ODEScenario.simulate()
      • ODEScenario.summary()
      • ODEScenario.to_dynamics()
      • ODEScenario.to_json()
      • ODEScenario.track()
• covsirphy.util package
  • Submodules
  • covsirphy.util.alias module
    • Alias
      • Alias.all()
      • Alias.delete()
      • Alias.find()
      • Alias.for_variables()
      • Alias.update()
  • covsirphy.util.config module
  • covsirphy.util.error module
    • EmptyError
    • ExperimentalWarning
    • NAFoundError
    • NotEnoughDataError
    • NotIncludedError
    • NotNoneError
    • NotRegisteredError
    • NotSubclassError
    • ScenarioNotFoundError
    • SubsetNotFoundError
    • UnExecutedError
    • UnExpectedLengthError
    • UnExpectedNoneError
    • UnExpectedTypeError
    • UnExpectedValueError
    • UnExpectedValueRangeError
    • deprecate()
    • experimental()
  • covsirphy.util.evaluator module
    • Evaluator
      • Evaluator.best_one()
      • Evaluator.metrics()
      • Evaluator.score()
      • Evaluator.smaller_is_better()
  • covsirphy.util.filer module
    • Filer
      • Filer.csv()
      • Filer.files()
      • Filer.geojson()
      • Filer.jpg()
      • Filer.json()
      • Filer.png()
  • covsirphy.util.stopwatch module
    • StopWatch
      • StopWatch.show()
      • StopWatch.stop()
      • StopWatch.stop_show()
  • covsirphy.util.term module
    • Term
      • Term.A
      • Term.ACTUAL
      • Term.AREA_ABBR_COLS
      • Term.AREA_COLUMNS
      • Term.C
      • Term.CI
      • Term.CITY
      • Term.COLUMNS
      • Term.COUNTRY
      • Term.DATE
      • Term.DATE_FORMAT
      • Term.DATE_FORMAT_DESC
      • Term.DSIFR_COLUMNS
      • Term.E
      • Term.END
      • Term.F
      • Term.FIG_COLUMNS
      • Term.FITTED
      • Term.FR
      • Term.FUTURE
      • Term.ID
      • Term.INITIAL
      • Term.ISO3
      • Term.MAIN
      • Term.MODERATE
      • Term.MONO_COLUMNS
      • Term.N
      • Term.NA
      • Term.NLOC_COLUMNS
      • Term.ODE
      • Term.OTHERS
      • Term.P
      • Term.PARAM_DICT
      • Term.PAST
      • Term.PHASE
      • Term.PRODUCT
      • Term.PROVINCE
      • Term.R
      • Term.RATE_COLUMNS
      • Term.RT
      • Term.RT_FULL
      • Term.RUNTIME
      • Term.S
      • Term.SEP
      • Term.SERIES
      • Term.SEVERE
      • Term.START
      • Term.STEP_N
      • Term.STR_COLUMNS
      • Term.SUB_COLUMNS
      • Term.SUFFIX_DICT
      • Term.T
      • Term.TAU
      • Term.TENSE
      • Term.TESTS
      • Term.TESTS_DIFF
      • Term.TRIALS
      • Term.TS
      • Term.V
      • Term.VAC
      • Term.VAC_BOOSTERS
      • Term.VALUE_COLUMNS
      • Term.V_FULL
      • Term.V_ONCE
      • Term.W
      • Term.Y0_DICT
      • Term.num2str()
      • Term.str2num()
  • covsirphy.util.validator module
    • Validator
      • Validator.dataframe()
      • Validator.date()
      • Validator.dict()
      • Validator.float()
      • Validator.instance()
      • Validator.int()
      • Validator.kwargs()
      • Validator.sequence()
      • Validator.subclass()
      • Validator.tau()
• covsirphy.visualization package
  • Submodules
  • covsirphy.visualization.bar_plot module
    • BarPlot
      • BarPlot.line()
      • BarPlot.plot()
      • BarPlot.x_axis()
      • BarPlot.y_axis()
    • bar_plot()
  • covsirphy.visualization.compare_plot module
    • ComparePlot
      • ComparePlot.plot()
    • compare_plot()
  • covsirphy.visualization.line_plot module
    • LinePlot
      • LinePlot.line()
      • LinePlot.plot()
      • LinePlot.x_axis()
      • LinePlot.y_axis()
    • line_plot()
  • covsirphy.visualization.scatter_plot module
    • ScatterPlot
      • ScatterPlot.legend()
      • ScatterPlot.legend_hide()
      • ScatterPlot.line_straight()
      • ScatterPlot.plot()
    • scatter_plot()
  • covsirphy.visualization.vbase module
    • VisualizeBase
      • VisualizeBase.ax
      • VisualizeBase.legend()
      • VisualizeBase.legend_hide()
      • VisualizeBase.plot()
      • VisualizeBase.tick_params()
      • VisualizeBase.title
    • find_args()