Skip to content
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
2 changes: 1 addition & 1 deletion docs/Community/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ representative at an online or offline event.

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
contact@formingworlds.space.
dev@proteus-framework.org.
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
Expand Down
2 changes: 1 addition & 1 deletion docs/Community/contact.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ We encourage you to reach out! Choose the most appropriate channel below.
|---------|---------|
| [GitHub Discussions](https://github.com/orgs/FormingWorlds/discussions) | Questions, installation help, feature suggestions |
| [GitHub Issues](https://github.com/FormingWorlds/SOCRATES/issues) | Bug reports, specific feature requests |
| [proteus_dev@formingworlds.space](mailto:proteus_dev@formingworlds.space) | General enquiries |
| [dev@proteus-framework.org](mailto:dev@proteus-framework.org) | General enquiries |
Binary file removed docs/assets/PROTEUS_black_on_white_logo_only.png
Binary file not shown.
Binary file removed docs/assets/PROTEUS_white_on_black.png
Binary file not shown.
Binary file removed docs/assets/PROTEUS_white_on_black_logo_only.png
Binary file not shown.
Binary file added docs/assets/favicon-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/favicon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/assets/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/assets/glyph_phase_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 1 addition & 6 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,3 @@
---
hide:
- navigation
---

<div class="socrates-getstarted" markdown = 1>

# Get started
Expand Down Expand Up @@ -61,7 +56,7 @@ navigation bar.

- :material-code-braces: **Contribute or develop**

[Go to contributing guide](Community/CONTRIBUTING.md)
[Go to contributing guide](https://proteus-framework.org/PROTEUS/Community/CONTRIBUTING.html)

- :material-bug: **Raise an issue**

Expand Down
21 changes: 5 additions & 16 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,12 @@
---
title: SOCRATES
hide:
- toc
- navigation
---
# SOCRATES

<div class="socrates-index" markdown = 1>
<p class="subtitle">Suite Of Community RAdiative Transfer codes based on Edwards and Slingo</p>

<h1 align = "center"> SOCRATES </h1>
[![License](https://img.shields.io/badge/License-BSD--3--Clause-blue.svg)](https://github.com/FormingWorlds/SOCRATES/blob/main/LICENCE)
[![Docs](https://img.shields.io/github/actions/workflow/status/FormingWorlds/SOCRATES/docs.yaml?branch=main&label=Docs)](https://proteus-framework.org/SOCRATES/)

<p align = "center" class="subtitle">Suite Of Community RAdiative Transfer codes based on Edwards and Slingo</p>
**SOCRATES** is the radiative transfer core of the [PROTEUS](https://proteus-framework.org/PROTEUS) coupled atmosphere-interior evolution framework, called by the radiative-convective atmosphere model [AGNI](https://www.h-nicholls.space/AGNI/). It is a high-performance code for computing fluxes, heating rates, and radiances in planetary atmospheres; its primary development and maintenance is led by the UK Met Office.

<p align="center">
<a href="https://github.com/FormingWorlds/SOCRATES/actions/workflows/docs.yaml"><img alt="Documentation" src="https://github.com/FormingWorlds/SOCRATES/actions/workflows/docs.yaml/badge.svg"></a>
<a href="https://github.com/FormingWorlds/SOCRATES/blob/main/LICENCE"><img alt="License: BSD-3-Clause" src="https://img.shields.io/badge/License-BSD--3--Clause-blue.svg"></a>
</p>

SOCRATES is a high-performance radiative transfer code for computing fluxes, heating rates, and radiances in planetary atmospheres. Its primary development and maintenance is lead by the UK Met Office. SOCRATES is applied as the radiative transfer core of the [PROTEUS framework](https://proteus-framework.org/PROTEUS/), called by the radiative-convective atmosphere model [AGNI](https://www.h-nicholls.space/AGNI/).

!!! info "PROTEUS framework"
This documentation describes SOCRATES as integrated into the PROTEUS framework for exoplanet atmosphere modelling. The original Met Office repository can be found [here](https://github.com/MetOffice/socrates).
Expand Down Expand Up @@ -67,4 +57,3 @@ SOCRATES is released under the [BSD 3-Clause Licence](https://github.com/Forming
!!! info "Licenses across the PROTEUS framework"
Different components within the PROTEUS framework carry different licenses. Please find information about the use of licenses within the PROTEUS framework on the website's [license page](https://proteus-framework.org/license/).

</div>
21 changes: 11 additions & 10 deletions docs/javascripts/header-links.js
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@ function wire() {
const homepage = "https://proteus-framework.org/";

const logo = document.querySelector(".md-header__button.md-logo");
if (logo) logo.href = homepage;
let docsHome = location.origin + "/";
if (logo) {
// The theme points the logo at this site's own home page. Remember that
// before repointing the logo at the framework home, so the title can use
// it and no page has to know its own name.
if (!logo.dataset.docsHome) logo.dataset.docsHome = logo.href;
docsHome = logo.dataset.docsHome;
logo.href = homepage;
}

const title = document.querySelector(".md-header__title[data-md-component='header-title']");
if (title && !title.dataset.spiderWired) {
title.dataset.spiderWired = "1";
if (title && !title.dataset.titleWired) {
title.dataset.titleWired = "1";
title.style.cursor = "pointer";

// always go to /SOCRATES/ when hosted there, else "/" (mkdocs serve)
const href = location.href;
const docsHome = href.includes("/SOCRATES/")
? href.split("/SOCRATES/")[0] + "/SOCRATES/"
: location.origin + "/";

title.addEventListener("click", (e) => {
if (e.target.closest("a, button, input, label")) return;
window.location.assign(docsHome);
Expand Down
42 changes: 38 additions & 4 deletions docs/overrides/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
<!-- EXTRAHEAD OVERRIDE LOADED -->

<link rel="icon" type="image/png"
href="{{ 'assets/PROTEUS_black_on_white_logo_only.png' | url }}"
href="{{ 'assets/favicon-light.png' | url }}"
media="(prefers-color-scheme: light)" />

<link rel="icon" type="image/png"
href="{{ 'assets/PROTEUS_white_on_black_logo_only.png' | url }}"
href="{{ 'assets/favicon.png' | url }}"
media="(prefers-color-scheme: dark)" />

<script>
Expand All @@ -33,8 +33,8 @@
}


const light = "{{ 'assets/PROTEUS_black_on_white_logo_only.png' | url }}";
const dark = "{{ 'assets/PROTEUS_white_on_black_logo_only.png' | url }}";
const light = "{{ 'assets/favicon-light.png' | url }}";
const dark = "{{ 'assets/favicon.png' | url }}";

const mql = window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)');

Expand All @@ -51,4 +51,38 @@
}
})();
</script>

<script>
// The served markup always carries the first palette listed in mkdocs.yml, so a
// reader whose setting is the other one sees the wrong palette until the theme
// resolves it. Resolving it here, and stamping it on the body the moment the
// body exists, means the first paint is already right. A scheme the reader chose
// by hand wins over the setting, read through the theme's own storage getter.
(function () {
var scheme = null;
try {
// The theme scopes its storage keys by path, so read through its own
// getter rather than guessing the key.
var stored = typeof __md_get === "function" ? __md_get("__palette") : null;
if (stored && stored.color && stored.color.media !== "(prefers-color-scheme)") {
scheme = stored.color.scheme;
}
} catch (e) { /* storage unavailable or unparseable; fall back to the setting */ }
if (!scheme) {
scheme = window.matchMedia && window.matchMedia("(prefers-color-scheme: dark)").matches
? "slate"
: "default";
}
if (document.body) {
document.body.setAttribute("data-md-color-scheme", scheme);
return;
}
new MutationObserver(function (records, observer) {
if (document.body) {
document.body.setAttribute("data-md-color-scheme", scheme);
observer.disconnect();
}
}).observe(document.documentElement, { childList: true });
})();
</script>
{% endblock %}
4 changes: 2 additions & 2 deletions docs/proteus_framework.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ hide:
<h1 align="center">
<a href="https://proteus-framework.org">
<div>
<img src="https://raw.githubusercontent.com/FormingWorlds/PROTEUS/main/docs/assets/PROTEUS_white.png#gh-light-mode-only" style="vertical-align: middle;" width="60%"/>
<img src="https://raw.githubusercontent.com/FormingWorlds/PROTEUS/main/docs/assets/PROTEUS_black_nobkg.png#gh-dark-mode-only" style="vertical-align: middle;" width="60%"/>
<img class="logo-light" src="https://cdn.jsdelivr.net/gh/FormingWorlds/PROTEUS@main/docs/assets/proteus-lockup-light-transparent.png" style="vertical-align: middle;" width="60%" alt="PROTEUS"/>
<img class="logo-dark" src="https://cdn.jsdelivr.net/gh/FormingWorlds/PROTEUS@main/docs/assets/proteus-lockup-dark-transparent.png" style="vertical-align: middle;" width="60%" alt="PROTEUS"/>
</div>
</a>
</h1>
Expand Down
25 changes: 0 additions & 25 deletions docs/stylesheets/diagram.css

This file was deleted.

Loading
Loading