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

Move docs to RimuQMC #297

Merged
merged 4 commits into from
Nov 26, 2024
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
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Rimu

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://joachimbrand.github.io/Rimu.jl/)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://joachimbrand.github.io/Rimu.jl/dev/)
[![Coverage Status](https://coveralls.io/repos/github/joachimbrand/Rimu.jl/badge.svg)](https://coveralls.io/github/joachimbrand/Rimu.jl)
[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://RimuQMC.github.io/Rimu.jl/)
[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://RimuQMC.github.io/Rimu.jl/dev/)
[![Coverage Status](https://coveralls.io/repos/github/RimuQMC/Rimu.jl/badge.svg)](https://coveralls.io/github/RimuQMC/Rimu.jl)

*Random Integrators for many-body quantum systems*

Expand Down Expand Up @@ -70,4 +70,4 @@ Papers discussing results obtained with `Rimu`:
- "Polaron-Depleton Transition in the Yrast Excitations of a One-Dimensional Bose Gas with a Mobile Impurity", M. Yang, M. Čufar, E. Pahl, J. Brand, [*Condens. Matter* **7**, 15 (2022)](https://www.mdpi.com/2410-3896/7/1/15).
- "Magnetic impurity in a one-dimensional few-fermion system", L. Rammelmüller, D. Huber, M. Čufar, J. Brand, A. Volosniev, [arXiv:2204.01606](http://arxiv.org/abs/2204.01606) (2022).

For more information, consult the [documentation](https://joachimbrand.github.io/Rimu.jl/dev/).
For more information, consult the [documentation](https://RimuQMC.github.io/Rimu.jl/dev/).
2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ makedocs(;
)

deploydocs(
repo = "github.com/joachimbrand/Rimu.jl.git",
repo = "github.com/RimuQMC/Rimu.jl.git",
push_preview = true,
)

Expand Down
14 changes: 7 additions & 7 deletions docs/src/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,25 +27,25 @@ deployed automatically with GitHub Actions. This needs to be set up with an appr
script in the file `.github/workflows/docs.yml`, where triggers for this to happen can be
defined. In the current set up, a new documentation web site is generated and deployed
whenever someone pushes to the develop branch on the GitHub server. The updated
documentation can then be accessed [here](https://joachimbrand.github.io/Rimu.jl/dev/).
documentation can then be accessed [here](https://RimuQMC.github.io/Rimu.jl/dev/).

Previews for pull-requests can be accessed by replacing 101 in the following link with the PR number: [https://joachimbrand.github.io/Rimu.jl/previews/PR101/](https://joachimbrand.github.io/Rimu.jl/previews/PR101/)
Previews for pull-requests can be accessed by replacing 101 in the following link with the PR number: [https://RimuQMC.github.io/Rimu.jl/previews/PR101/](https://RimuQMC.github.io/Rimu.jl/previews/PR101/)

### Example scripts

Examples should be added to the `scripts` folder, in the form of `.jl` files suitable for
parsing by [`Literate`](https://github.com/fredrikekre/Literate.jl). The process of generating
documentation is automated in the `docs/make.jl` file and assumes that the following line is
Examples should be added to the `scripts` folder, in the form of `.jl` files suitable for
parsing by [`Literate`](https://github.com/fredrikekre/Literate.jl). The process of generating
documentation is automated in the `docs/make.jl` file and assumes that the following line is
at (or near) the top of the script:
```
# # Example N: Title
```
where the number `N` and `Title` will be extracted automatically.

Tests for the results and output of specific scripts should be added at the end of each example. The code to run the test should be hidden from the final generated document by
appending "#hide" to each line of testing code. For example,
appending "#hide" to each line of testing code. For example,
```
using Test #hide
@test isfile("result.out") #hide
@test result == expected_result #hide
```
```
2 changes: 1 addition & 1 deletion scripts/BHM-example-mpi.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# Rimu provides support for MPI to enable parallel computations on multiple nodes.

# A runnable script for this example is located
# [here](https://github.com/joachimbrand/Rimu.jl/blob/develop/scripts/BHM-example-mpi.jl).
# [here](https://github.com/RimuQMC/Rimu.jl/blob/develop/scripts/BHM-example-mpi.jl).
# Run it with 2 MPI ranks with `mpirun -n 2 julia BHM-example-mpi.jl`.

# We start by importing `Rimu`.
Expand Down
2 changes: 1 addition & 1 deletion scripts/BHM-example.jl
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# particles in 6 lattice sites.

# A runnable script for this example is located
# [here](https://github.com/joachimbrand/Rimu.jl/blob/develop/scripts/BHM-example.jl).
# [here](https://github.com/RimuQMC/Rimu.jl/blob/develop/scripts/BHM-example.jl).
# Run it with `julia BHM-example.jl`.

# First, we load Rimu and Plots.
Expand Down
2 changes: 1 addition & 1 deletion scripts/G2-example.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# This is an example calculation of the two-body correlation function ``G_2``.

# A runnable script for this example is located
# [here](https://github.com/joachimbrand/Rimu.jl/blob/develop/scripts/G2-example.jl).
# [here](https://github.com/RimuQMC/Rimu.jl/blob/develop/scripts/G2-example.jl).
# Run it with `julia G2-example.jl`.

# First, we load the reqired packages. `Rimu` for FCIQMC calculation, and `DataFrames` for
Expand Down
2 changes: 1 addition & 1 deletion scripts/HO-example.jl
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
# how to generate these blocks and find the energy and angular momentum eigenstates.

# A runnable script for this example is located
# [here](https://github.com/joachimbrand/Rimu.jl/blob/develop/scripts/HO-example.jl).
# [here](https://github.com/RimuQMC/Rimu.jl/blob/develop/scripts/HO-example.jl).
# Run it with `julia HO-example.jl`.

# First, load all needed packages.
Expand Down
2 changes: 1 addition & 1 deletion scripts/exact-example.jl
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
# as well as provide a few tips regarding them.

# A runnable script for this example is located
# [here](https://github.com/joachimbrand/Rimu.jl/blob/develop/scripts/exact-example.jl).
# [here](https://github.com/RimuQMC/Rimu.jl/blob/develop/scripts/exact-example.jl).
# Run it with `julia exact-example.jl`.

# We start by loading Rimu.
Expand Down
2 changes: 1 addition & 1 deletion src/Hamiltonians/correlation_functions.jl
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ Superfluid correlations can be extracted from a Monte Carlo calculation by wrapp
`SuperfluidCorrelator` with [`AllOverlaps`](@ref) and passing into
[`ProjectorMonteCarloProblem`](@ref) with the `replica` keyword argument. For an example
with a similar use of [`G2RealCorrelator`](@ref) see
[G2 Correlator Example](https://joachimbrand.github.io/Rimu.jl/previews/PR227/generated/G2-example.html).
[G2 Correlator Example](https://RimuQMC.github.io/Rimu.jl/previews/PR227/generated/G2-example.html).


See also [`HubbardReal1D`](@ref), [`G2RealCorrelator`](@ref), [`AbstractOperator`](@ref),
Expand Down
2 changes: 1 addition & 1 deletion src/Rimu.jl
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ const PACKAGE_VERSION = VersionNumber(TOML.parsefile(pkgdir(Rimu, "Project.toml"
**Random integrators for many-body quantum systems**

Welcome to `Rimu` version $PACKAGE_VERSION.
Read the documentation [online](https://joachimbrand.github.io/Rimu.jl/).
Read the documentation [online](https://RimuQMC.github.io/Rimu.jl/).
"""
Rimu

Expand Down
Loading