update index page

[jd-lara]

More documentation updates

[github-actions]

[JuliaFormatter] _{reported by reviewdog 🐶}

Suggested change

	Each formulation can have different implementations for attributes. Carefully review the formulation library pages to understand how to configure the storage model according to your requirements
	Each formulation can have different implementations for attributes. Carefully review the formulation library pages to understand how to configure the storage model according to your requirements

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 31.54%. Comparing base (676061f) to head (6541120).

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #31   +/-   ##
=======================================
  Coverage   31.54%   31.54%           
=======================================
  Files           9        9           
  Lines         932      932           
=======================================
  Hits          294      294           
  Misses        638      638           

Flag	Coverage Δ
unittests	31.54% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files	Coverage Δ
src/StorageSystemsSimulations.jl	33.33% <ø> (ø)
src/core/variables.jl	33.33% <ø> (ø)

[github-actions]

[JuliaFormatter] _{reported by reviewdog 🐶}

Suggested change

[kdayday]

@jd-lara Here are the docstrings needed in constraints.jl and variables.jl:

• AncillaryServiceVariableDischarge
• AncillaryServiceVariableCharge
• StateofChargeLimitsConstraint
• StorageCyclingCharge
• StorageCyclingDischarge
• ReserveCoverageConstraint
• ReserveCoverageConstraintEndOfPeriod
• ReserveCompleteCoverageConstraint
• ReserveCompleteCoverageConstraintEndOfPeriod
• StorageTotalReserveConstraint
• ReserveDischargeConstraint
• ReserveChargeConstraint

These constraints are not exported and also don't have docstrings. They don't show up in either the public or internal API. Should they be exported?

• StateofChargeTargetConstraint
• StorageRegularizationConstraintCharge
• StorageRegularizationConstraintDischarge

[rodrigomha]

This PR should try to close #45 (if possible)
and also #34 (if possible)

[kdayday]

This PR should try to close #45 (if possible) and also #34 (if possible)

Or these could be addressed as part of Anna's re-organization @annacasavant, in order to focus this on just getting running again

[kdayday]

@jd-lara Here are the docstrings needed in constraints.jl and variables.jl:

* [ ]  AncillaryServiceVariableDischarge

* [ ]  AncillaryServiceVariableCharge

* [ ]  StateofChargeLimitsConstraint

* [ ]  StorageCyclingCharge

* [ ]  StorageCyclingDischarge

* [ ]  ReserveCoverageConstraint

* [ ]  ReserveCoverageConstraintEndOfPeriod

* [ ]  ReserveCompleteCoverageConstraint

* [ ]  ReserveCompleteCoverageConstraintEndOfPeriod

* [ ]  StorageTotalReserveConstraint

* [ ]  ReserveDischargeConstraint

* [ ]  ReserveChargeConstraint

These constraints are not exported and also don't have docstrings. They don't show up in either the public or internal API. Should they be exported?

* [ ]   StateofChargeTargetConstraint

* [ ]  StorageRegularizationConstraintCharge

* [ ]  StorageRegularizationConstraintDischarge

@jd-lara @rodrigomha @rafamonvar What's the status on getting these docstrings filled out? If you don't have availability, could of you share the Latex file with @annacasavant to finish this PR? Thanks!

[rodrigomha]

Just rebased with main. Documentation is compiling correctly locally using PowerSimulations main. We need to get a release for PowerSimulations that can use the new version of storage.