Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ExecutionDigest #767

Merged
merged 1 commit into from
Jul 21, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ package lucuma.core.model.sequence

import cats.Eq
import cats.syntax.foldable.*
import lucuma.core.enums.ObserveClass
import lucuma.core.util.TimeSpan
import monocle.Focus
import monocle.Lens

Expand All @@ -25,28 +23,14 @@ case class ExecutionConfig[S, D](
) {

/**
* ObserveClass computed from the ObserveClass of the science sequence atoms.
* Execution summary computed from the sequences.
*/
lazy val observeClass: ObserveClass =
science.fold(ObserveClass.Science)(_.digest.observeClass)

private def plannedTime(setup: TimeSpan): PlannedTime =
science.foldMap(_.digest.plannedTime).sumCharge(observeClass.chargeClass, setup)

/**
* Planned time for the observation, including the science sequence and a
* full setup time.
*/
lazy val fullPlannedTime: PlannedTime =
plannedTime(setup.full)

/**
* Planned time for the observation, including the science sequence but only
* a reacquisition cost instead of the full setup time.
*/
lazy val reacquisitionPlannedTime: PlannedTime =
plannedTime(setup.reacquisition)

def executionDigest: ExecutionDigest =
ExecutionDigest(
setup,
acquisition.fold(SequenceDigest.Zero)(_.digest),
science.fold(SequenceDigest.Zero)(_.digest)
)
}

object ExecutionConfig {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
// Copyright (c) 2016-2023 Association of Universities for Research in Astronomy, Inc. (AURA)
// For license information see LICENSE or https://opensource.org/licenses/BSD-3-Clause

package lucuma.core.model.sequence

import cats.Eq
import lucuma.core.enums.ObserveClass
import monocle.Focus
import monocle.Lens

case class ExecutionDigest(
setup: SetupTime,
acquisition: SequenceDigest,
science: SequenceDigest
) {

/**
* ObserveClass computed from the ObserveClass of the science sequence atoms.
*/
lazy val observeClass: ObserveClass =
science.observeClass

/**
* Planned time for the observation, including the science sequence but only
* a reacquisition cost instead of the full setup time.
*/
def reacquisitionPlannedTime: PlannedTime =
science.plannedTime.sumCharge(science.observeClass.chargeClass, setup.reacquisition)

/**
* Planned time for the observation, including the science sequence and a
* full setup time.
*/
def fullPlannedTime: PlannedTime =
science.plannedTime.sumCharge(science.observeClass.chargeClass, setup.full)

}

object ExecutionDigest {

val Zero: ExecutionDigest =
ExecutionDigest(
SetupTime.Zero,
SequenceDigest.Zero,
SequenceDigest.Zero
)

/** @group Optics */
val setup: Lens[ExecutionDigest, SetupTime] =
Focus[ExecutionDigest](_.setup)

/** @group Optics */
val acquisition: Lens[ExecutionDigest, SequenceDigest] =
Focus[ExecutionDigest](_.acquisition)

/** @group Optics */
val science: Lens[ExecutionDigest, SequenceDigest] =
Focus[ExecutionDigest](_.science)

given Eq[ExecutionDigest] =
Eq.by { a => (
a.setup,
a.acquisition,
a.science
)}

}
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ import monocle.macros.GenPrism
*/
sealed trait InstrumentExecutionConfig {
def instrument: Instrument
def executionDigest: ExecutionDigest
}

object InstrumentExecutionConfig {
Expand All @@ -23,6 +24,9 @@ object InstrumentExecutionConfig {
) extends InstrumentExecutionConfig {
def instrument: Instrument =
Instrument.GmosNorth

def executionDigest: ExecutionDigest =
executionConfig.executionDigest
}

object GmosNorth {
Expand All @@ -38,6 +42,9 @@ object InstrumentExecutionConfig {
) extends InstrumentExecutionConfig {
def instrument: Instrument =
Instrument.GmosSouth

def executionDigest: ExecutionDigest =
executionConfig.executionDigest
}

object GmosSouth {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,15 +56,15 @@ object SequenceDigest {
)

/** @group Optics */
def observeClass: Lens[SequenceDigest, ObserveClass] =
val observeClass: Lens[SequenceDigest, ObserveClass] =
Focus[SequenceDigest](_.observeClass)

/** @group Optics */
def plannedTime: Lens[SequenceDigest, PlannedTime] =
val plannedTime: Lens[SequenceDigest, PlannedTime] =
Focus[SequenceDigest](_.plannedTime)

/** @group Optics */
def offsets: Lens[SequenceDigest, SortedSet[Offset]] =
val offsets: Lens[SequenceDigest, SortedSet[Offset]] =
Focus[SequenceDigest](_.offsets)

given Monoid[SequenceDigest] with {
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
// Copyright (c) 2016-2023 Association of Universities for Research in Astronomy, Inc. (AURA)
// For license information see LICENSE or https://opensource.org/licenses/BSD-3-Clause

package lucuma.core.model.sequence
package arb

import org.scalacheck.Arbitrary
import org.scalacheck.Arbitrary.*
import org.scalacheck.Cogen

trait ArbExecutionDigest {

import ArbSetupTime.given
import ArbSequenceDigest.given

given Arbitrary[ExecutionDigest] =
Arbitrary {
for {
c <- arbitrary[SetupTime]
a <- arbitrary[SequenceDigest]
s <- arbitrary[SequenceDigest]
} yield ExecutionDigest(c, a, s)
}

given Cogen[ExecutionDigest] =
Cogen[(
SetupTime,
SequenceDigest,
SequenceDigest
)].contramap { a => (
a.setup,
a.acquisition,
a.science
)}
}

object ArbExecutionDigest extends ArbExecutionDigest
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// Copyright (c) 2016-2023 Association of Universities for Research in Astronomy, Inc. (AURA)
// For license information see LICENSE or https://opensource.org/licenses/BSD-3-Clause

package lucuma.core.model.sequence

import cats.kernel.laws.discipline.*
import lucuma.core.model.sequence.arb.ArbExecutionDigest
import munit.*

final class ExecutionDigestSuite extends DisciplineSuite {

import ArbExecutionDigest.given

checkAll("Eq[ExecutionDigest]", EqTests[ExecutionDigest].eqv)

}