Skip to content

Commit

Permalink
Modify SSMProblems to work with AbstractMCMC interface (#22)
Browse files Browse the repository at this point in the history
* Update documentation to match new interface

* Incorporate SSMProblems into AbstractMCMC

* Update Project.toml (#24)

* Update Project.toml

* Update make.jl

---------

Co-authored-by: Hong Ge <[email protected]>
  • Loading branch information
THargreaves and yebai authored Nov 10, 2023
1 parent 9bd31b0 commit e1595b0
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
6 changes: 5 additions & 1 deletion Project.toml
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
name = "SSMProblems"
uuid = "26aad666-b158-4e64-9d35-0e672562fa48"
authors = ["FredericWantiez <[email protected]>"]
version = "0.1.0"
version = "0.1.1"

[deps]
AbstractMCMC = "80f14c24-f653-4e6a-9b94-39d6b0f70001"

[compat]
AbstractMCMC = "5"
julia = "1.6"

2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ DocMeta.setdocmeta!(SSMProblems, :DocTestSetup, :(using SSMProblems); recursive=
makedocs(;
sitename="SSMProblems",
format=Documenter.HTML(; size_threshold=1000 * 2^11), # 1Mb per page
modules=[SSMProblems],
#modules=[SSMProblems],
pages=[
"Home" => "index.md",
"Examples" => [
Expand Down
4 changes: 3 additions & 1 deletion src/SSMProblems.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ A unified interface to define State Space Models interfaces in the context of Pa
"""
module SSMProblems

using AbstractMCMC: AbstractMCMC

"""
AbstractStateSpaceModel
"""
abstract type AbstractStateSpaceModel end
abstract type AbstractStateSpaceModel <: AbstractMCMC.AbstractModel end
abstract type AbstractParticleCache end

"""
Expand Down

2 comments on commit e1595b0

@yebai
Copy link
Member

@yebai yebai commented on e1595b0 Nov 10, 2023

Choose a reason for hiding this comment

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

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/95137

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.1 -m "<description of version>" e1595b0eae3e49a0458db71ca67991dea5ece2de
git push origin v0.1.1

Please sign in to comment.