Skip to content

Commit

Permalink
Rename to DynamicModelTestUtils
Browse files Browse the repository at this point in the history
  • Loading branch information
BenChung committed Jun 17, 2024
1 parent 0bbe9e0 commit 805046f
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 20 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ jobs:
- run: |
julia --project=docs -e '
using Documenter: doctest
using ModelTesting
doctest(ModelTesting)'
using DynamicModelTestUtils
doctest(DynamicModelTestUtils)'
- run: julia --project=docs docs/make.jl
env:
JULIA_PKG_SERVER: ""
Expand Down
4 changes: 2 additions & 2 deletions Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "ModelTesting"
name = "DynamicModelTestUtils"
uuid = "726cd793-0c59-4a7a-97d2-1baad301d093"
authors = ["Ben Chung <benjamin.chung@juliahub.com> and contributors"]
version = "0.1.0"
version = "0.1.1"

[deps]
CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# ModelTesting
ModelTesting is a simple package that wraps SymbolicIndexingInterface to provide straightforward model regression analysis & comparision functionality.
# DynamicModelTestUtils
DynamicModelTestUtils is a simple package that wraps SymbolicIndexingInterface to provide straightforward model regression analysis & comparision functionality.

It can export model result data using `discretize_solution` into a DataFrame and can compare against those DataFrames using `compare`. It's intended for use in CI pipelines.
12 changes: 6 additions & 6 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
using ModelTesting
using DynamicModelTestUtils
using Documenter

DocMeta.setdocmeta!(ModelTesting, :DocTestSetup, :(using ModelTesting); recursive=true)
DocMeta.setdocmeta!(DynamicModelTestUtils, :DocTestSetup, :(using DynamicModelTestUtils); recursive=true)

makedocs(;
modules=[ModelTesting],
modules=[DynamicModelTestUtils],
authors="Ben Chung <benjamin.chung@juliahub.com> and contributors",
repo="https://github.com/BenChung/ModelTesting.jl/blob/{commit}{path}#{line}",
sitename="ModelTesting.jl",
repo="https://github.com/BenChung/DynamicModelTestUtils.jl/blob/{commit}{path}#{line}",
sitename="DynamicModelTestUtils.jl",
format=Documenter.HTML(;
prettyurls=get(ENV, "CI", "false") == "true",
edit_link="master",
Expand All @@ -18,5 +18,5 @@ makedocs(;
],
)
deploydocs(
repo = "github.com/JuliaComputing/ModelTesting.jl.git",
repo = "github.com/JuliaComputing/DynamicModelTestUtils.jl.git",
)
10 changes: 5 additions & 5 deletions docs/src/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
```@meta
CurrentModule = ModelTesting
CurrentModule = DynamicModelTestUtils
```

# ModelTesting
# DynamicModelTestUtils

Documentation for [ModelTesting](https://github.com/BenChung/ModelTesting.jl).
Documentation for [DynamicModelTestUtils](https://github.com/BenChung/DynamicModelTestUtils.jl).

ModelTesting is intended to facilitate the easy testing and post-facto analysis of ModelingToolkit models. It currently provides two key bits of functionality:
DynamicModelTestUtils is intended to facilitate the easy testing and post-facto analysis of ModelingToolkit models. It currently provides two key bits of functionality:

* Serialization of MTK solutions into a common format through `discretize_solution`.
* Comparison of solutions to each other and to previously-saved data through `compare`.
Expand All @@ -16,5 +16,5 @@ ModelTesting is intended to facilitate the easy testing and post-facto analysis
```

```@autodocs
Modules = [ModelTesting]
Modules = [DynamicModelTestUtils]
```
3 changes: 2 additions & 1 deletion src/ModelTesting.jl → src/DynamicModelTestUtils.jl
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
module ModelTesting
module DynamicModelTestUtils
using DataFrames, StatsBase, LinearAlgebra
using ModelingToolkit, SciMLBase, SymbolicIndexingInterface
abstract type DiscreteEvaluation end
Expand All @@ -8,4 +8,5 @@ include("test/discretize.jl")
include("test/instant.jl")
include("test/compare.jl")
include("problem_config/problem.jl")
include("deploy/deploy.jl")
end
5 changes: 3 additions & 2 deletions test/runtests.jl
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
#using JuliaSimModelOptimizer
using ModelTesting
using DynamicModelTestUtils
using DifferentialEquations, DataFrames, ModelingToolkit
import SymbolicIndexingInterface
using Test

@testset "ModelTesting.jl" begin
@testset "DynamicModelTestUtils.jl" begin
#include("timeseries.jl")
include("block_modeling.jl")
include("instantaneous.jl")
include("deployment.jl")
end

0 comments on commit 805046f

Please sign in to comment.