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

Update make.jl #384

Merged
merged 9 commits into from
Jul 2, 2024
Merged
Show file tree
Hide file tree
Changes from 8 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
4 changes: 2 additions & 2 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,9 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: julia-actions/setup-julia@v1
- uses: julia-actions/setup-julia@v2
with:
version: '1.6'
version: '1'
- name: Install dependencies
run: julia --project=docs -e 'using Pkg; Pkg.update(); Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and deploy
Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,13 @@
[![Documentation](https://github.com/NREL-Sienna/InfrastructureSystems.jl/workflows/Documentation/badge.svg)](https://nrel-sienna.github.io/InfrastructureSystems.jl/stable/)
[![DOI](https://zenodo.org/badge/202787784.svg)](https://zenodo.org/badge/latestdoi/202787784)

The `InfrastructureSystems.jl` package provides utilities to support data models for infrastructure modeling in [NREL-Sienna](https://github.com/NREL-Sienna). The `InfrastructureSystems.jl` package is used to support functionalities in [PowerSystems.jl](https://github.com/NREL-Sienna/PowerSystems.jl), [PowerSimulations.jl](https://github.com/NREL-Sienna/PowerSimulations.jl), [PowerSimulationsDynamics.jl](https://github.com/NREL-Sienna/PowerSimulationsDynamics.jl) and other modeling packages in the Sienna ecosystem.
The `InfrastructureSystems.jl` package provides utilities to support data models for infrastructure modeling in [NREL-Sienna](https://github.com/NREL-Sienna). The `InfrastructureSystems.jl` package is used to support functionalities in [PowerSystems.jl](https://github.com/NREL-Sienna/PowerSystems.jl), [PowerSimulations.jl](https://github.com/NREL-Sienna/PowerSimulations.jl), [PowerSimulationsDynamics.jl](https://github.com/NREL-Sienna/PowerSimulationsDynamics.jl) and other modeling packages in the Sienna ecosystem.

This package is only compatible with Julia 1.6 or higher.

## Development

Contributions to the development and enahancement of PowerSystems is welcome. Please see [CONTRIBUTING.md](https://github.com/NREL-Sienna/InfrastructureSystems.jl/blob/master/CONTRIBUTING.md) for code contribution guidelines.
Contributions to the development and enahancement of InfrastructureSystems is welcome. Please see [CONTRIBUTING.md](https://github.com/NREL-Sienna/InfrastructureSystems.jl/blob/master/CONTRIBUTING.md) for code contribution guidelines.

## License

Expand Down
3 changes: 0 additions & 3 deletions docs/Project.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,4 @@ InfrastructureSystems = "2cd47ed4-ca9b-11e9-27f2-ab636a7671f1"
Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"

[compat]
CSV = "~0.9"
Documenter = "0.25"
InfrastructureSystems = "2"
julia = "^1.5"
10 changes: 7 additions & 3 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -46,16 +46,20 @@ end

makedocs(
modules = [InfrastructureSystems],
format = Documenter.HTML(prettyurls = haskey(ENV, "GITHUB_ACTIONS"),),
format = Documenter.HTML(
prettyurls = haskey(ENV, "GITHUB_ACTIONS"),
size_threshold = nothing),
sitename = "InfrastructureSystems.jl",
pages = Any[p for p in pages]
pages = Any[p for p in pages],
warnonly = Documenter.except(),
)


deploydocs(
repo = "github.com/NREL-Sienna/InfrastructureSystems.jl.git",
target = "build",
branch = "gh-pages",
devbranch = "master",
devbranch = "main",
devurl = "dev",
versions = ["stable" => "v^", "v#.#"],
push_preview = true,
Expand Down
9 changes: 6 additions & 3 deletions docs/src/dev_guide/tests.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,31 @@
# Running Tests

## Standard test execution

Unit tests can be executed in the REPL by executing the following:

```julia
julia> ] test
```

## Interactive test execution

While developing code and tests it can be convenient to run a subset of tests.
You can do this with a combination of TestEnv.jl and ReTest.jl.

**Note**: Per recommendations from the developers of TestEnv.jl, install the package
in your global julia environment. Do the same for Revise.jl.

```
$ julia
\$ julia
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are the backslashes for?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The documenter throws an error if there are not escaped $ symbols

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I reverted the change

julia> ]
(@v1.10) pkg> add TestEnv Revise
```

Start the environment with the InfrastructureSystems.jl environment.

```
$ julia --project
\$ julia --project
```

Load the test environment.
Expand All @@ -48,7 +51,7 @@ julia> run_tests(r"Test.*components")
```

Refer to the [ReTest documentation](https://juliatesting.github.io/ReTest.jl/stable/) for more
information.
information.

## Change logging levels

Expand Down
4 changes: 2 additions & 2 deletions docs/src/dev_guide/time_series.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,6 @@ build a new file with only the active objects. The HDF5 tools package provides
the tool `h5repack` for this purpose.

```bash
$ h5repack time_series.h5 new.h5
$ mv new.h5 time_series.h5
\$ h5repack time_series.h5 new.h5
\$ mv new.h5 time_series.h5
```
2 changes: 1 addition & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
CurrentModule = InfrastructureSystems
```

### Overview
## Overview

`InfrastructureSystems.jl` is a [`Julia`](http://www.julialang.org) package that provides
data management services and common utility software for the packages in
Expand Down
2 changes: 1 addition & 1 deletion docs/src/style.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ add their own as needed.

## Unit Tests

All code should be tested. The packages in SIIP have a minimum of 70% coverage to be merged
All code should be tested. The packages in Sienna have a minimum of 70% coverage to be merged
into master. This functionality is provided using Codecov

## Whitespace
Expand Down
Loading