Skip to content

Commit

Permalink
add CMS section to docs
Browse files Browse the repository at this point in the history
  • Loading branch information
pfackeldey committed Apr 25, 2024
1 parent 60d8ee1 commit 9ede761
Show file tree
Hide file tree
Showing 4 changed files with 274 additions and 17 deletions.
8 changes: 7 additions & 1 deletion docs/building_blocks.md
Original file line number Diff line number Diff line change
@@ -1 +1,7 @@
# Modifiers
# Building Blocks

## Parameter

## Effect

## Modifier
2 changes: 1 addition & 1 deletion docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,13 @@
html_favicon = "../assets/favicon.png"

extensions = [
"myst_parser",
"sphinx.ext.autodoc",
"sphinx.ext.intersphinx",
"sphinx.ext.viewcode",
"sphinx.ext.mathjax",
"sphinx.ext.napoleon",
"sphinx.ext.autosectionlabel",
"myst_parser",
"sphinx_copybutton",
"sphinx_design",
]
Expand Down
30 changes: 15 additions & 15 deletions docs/evermore_for_ATLAS.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ If you are coming from the ATLAS experiment, you are probably familiar with the
In the following, you will find a brief comparison how modifier types of
{math}`\pyhf` can be implemented in evermore.

## Simple Example
## Simple Example (pyhf)

This is a simple example of a signal process scaled by an unconstrained modifier
{math}`\mu` and a background process with a normalization uncertainty (normsys).

::::{tab-set}
:::{tab-item} pyhf

```python
```{code-block} python
import pyhf
Expand Down Expand Up @@ -56,7 +56,7 @@ model.expected_data([0.5, 1.12], include_auxdata=False)

:::{tab-item} evermore <img src="../assets/favicon.png" height="1.5em">

```python
```{code-block} python
import jax
import jax.numpy as jnp
import evermore as evm
Expand Down Expand Up @@ -102,7 +102,7 @@ See
::::{tab-set}
:::{tab-item} pyhf

```json
```{code-block} json
{
"name": "mod_name",
"type": "shapesys",
Expand All @@ -114,7 +114,7 @@ See

:::{tab-item} evermore <img src="../assets/favicon.png" height="1.5em">

```python
```{code-block} python
from jaxtyping import Array
import jax.numpy as jnp
import evermore as evm
Expand All @@ -140,7 +140,7 @@ See
::::{tab-set}
:::{tab-item} pyhf

```json
```{code-block} json
{
"name": "mod_name",
"type": "histosys",
Expand All @@ -152,7 +152,7 @@ See

:::{tab-item} evermore <img src="../assets/favicon.png" height="1.5em">

```python
```{code-block} python
import jax.numpy as jnp
import evermore as evm
Expand Down Expand Up @@ -187,7 +187,7 @@ See
::::{tab-set}
:::{tab-item} pyhf

```json
```{code-block} json
{
"name": "mod_name",
"type": "normsys",
Expand All @@ -199,7 +199,7 @@ See

:::{tab-item} evermore <img src="../assets/favicon.png" height="1.5em">

```python
```{code-block} python
import jax.numpy as jnp
import evermore as evm
Expand All @@ -226,7 +226,7 @@ See
::::{tab-set}
:::{tab-item} pyhf

```json
```{code-block} json
{
"name": "mod_name",
"type": "staterror",
Expand All @@ -238,7 +238,7 @@ See

:::{tab-item} evermore <img src="../assets/favicon.png" height="1.5em">

```python
```{code-block} python
import jax.numpy as jnp
import evermore as evm
Expand Down Expand Up @@ -276,7 +276,7 @@ See

:::{tab-item} pyhf

```json
```{code-block} json
{
"name": "mod_name",
"type": "normfactor",
Expand All @@ -288,7 +288,7 @@ See

:::{tab-item} evermore <img src="../assets/favicon.png" height="1.5em">

```python
```{code-block} python
import jax.numpy as jnp
import evermore as evm
Expand Down Expand Up @@ -316,7 +316,7 @@ See

:::{tab-item} pyhf

```json
```{code-block} json
{
"name": "mod_name",
"type": "shapefactor",
Expand All @@ -328,7 +328,7 @@ See

:::{tab-item} evermore <img src="../assets/favicon.png" height="1.5em">

```python
```{code-block} python
import jax.numpy as jnp
import evermore as evm
Expand Down
Loading

0 comments on commit 9ede761

Please sign in to comment.