Skip to content

Commit b890c8a

Browse files
committed
ENH: Update builds for other export formats
1 parent 1cdca2d commit b890c8a

File tree

5 files changed

+94
-79
lines changed

5 files changed

+94
-79
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,3 +53,5 @@ yarn-error.log*
5353
venv/
5454
env/
5555
.env
56+
57+
exports/

CITATION.cff

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
cff-version: 1.2.0
2+
message: Please cite the following works when using this project.
3+
title: Insight Journal MyST Template
4+
authors:
5+
- family-names: Galilei
6+
given-names: Galileo
7+
affiliation: Pisa University
8+
address: Tower Drive, Pisa, Italy
9+
orcid: 0000-0000-0000-0001
10+
11+
- family-names: Bruno
12+
given-names: Giordano
13+
affiliation: Rome University
14+
address: Inquisition Street, Rome, Italy
15+
orcid: 0000-0000-0000-0002
16+
17+
- family-names: Leeuwenhoek
18+
given-names: Anthony
19+
affiliation: Netherlands Pragmatic University
20+
address: Port Street, Netherlands
21+
orcid: 0000-0000-0000-0003
22+
23+
contact:
24+
- family-names: Galilei
25+
given-names: Galileo
26+
affiliation: Pisa University
27+
address: Tower Drive, Pisa, Italy
28+
orcid: 0000-0000-0000-0001
29+
30+
license: CC-BY-4.0
31+
license-url: https://creativecommons.org/licenses/by/4.0/
32+
repository: https://github.com/InsightSoftwareConsortium/InsightJournalTemplate

docs/index.md

Lines changed: 25 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,15 @@
11
---
22
title: The Importance of Open Access in Scientific Publications
33
subtitle: A Template for MyST Markdown Articles in the Insight Journal
4+
abstract: |
5+
This document describes a new algorithm implemented using the Insight Toolkit
6+
ITK (www.itk.org). The code of the algorithm is written following the
7+
ITK CodingStyle as described in the directory ITK/Documentation/Style.pdf.
8+
9+
This paper is accompanied with the source code, input data, parameters and
10+
output data that the authors used for validating the algorithm described in
11+
this paper. This adheres to the fundamental principle that scientific
12+
publications must facilitate reproducibility of the reported results.
413
authors:
514
- name: Galileo Galilei
615
@@ -24,40 +33,29 @@ affiliations:
2433
- id: Netherlands Pragmatic University
2534
name: Netherlands Pragmatic University
2635
address: Port Street, Netherlands
27-
date: 2024-07-14
36+
37+
# License and access
38+
license:
39+
code: Apache-2.0
40+
content: CC-BY-4.0
41+
open_access: true
42+
43+
# Repository links
44+
github: InsightSoftwareConsortium/InsightJournalTemplate
45+
46+
# Keywords for indexing
2847
keywords:
2948
- open science
3049
- reproducible research
3150
- image processing
3251
- ITK
3352
- scientific computing
34-
license: CC-BY-4.0
35-
open_access: true
36-
subject: Computer Science
37-
venue:
38-
title: Insight Journal
39-
url: https://insight-journal.org
40-
github: InsightSoftwareConsortium/InsightJournalTemplate
41-
doi: 10.5281/zenodo.1234567
42-
abstract: |
43-
This document describes a new algorithm implemented using the Insight Toolkit
44-
ITK (www.itk.org). The code of the algorithm is written following the
45-
ITK CodingStyle as described in the directory ITK/Documentation/Style.pdf.
53+
- MyST markdown
4654

47-
This paper is accompanied with the source code, input data, parameters and
48-
output data that the authors used for validating the algorithm described in
49-
this paper. This adheres to the fundamental principle that scientific
50-
publications must facilitate reproducibility of the reported results.
51-
exports:
52-
- format: pdf
53-
template: arxiv_two_column
54-
article_type: research-article
55-
- format: pdf
56-
template: plain_latex_book
57-
- format: meca
58-
- format: tex
59-
bibliography:
60-
- references.bib
55+
abbreviations:
56+
FAIR: Findable, Accessible, Interoperable, and Reusable
57+
ITK: Insight Toolkit
58+
WASM: WebAssembly
6159
---
6260

6361
Using filters from the Insight Toolkit, we develop an algorithm for detecting

myst.yml

Lines changed: 24 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ project:
44
id: insight-journal-000
55
title: Insight Journal MyST Template
66
description: A template for open science article submissions to the Insight Journal using MyST Markdown
7+
78
authors:
89
- name: Galileo Galilei
910
1011
affiliation: Pisa University
1112
orcid: 0000-0000-0000-0001
12-
corresponding: true
1313
- name: Giordano Bruno
1414
1515
affiliation: Rome University
@@ -18,6 +18,16 @@ project:
1818
1919
affiliation: Netherlands Pragmatic University
2020
orcid: 0000-0000-0000-0003
21+
affiliations:
22+
- id: Pisa University
23+
name: Pisa University
24+
address: Tower Drive, Pisa, Italy
25+
- id: Rome University
26+
name: Rome University
27+
address: Inquisition Street, Rome, Italy
28+
- id: Netherlands Pragmatic University
29+
name: Netherlands Pragmatic University
30+
address: Port Street, Netherlands
2131

2232
# License and access
2333
license:
@@ -28,45 +38,28 @@ project:
2838
# Repository links
2939
github: InsightSoftwareConsortium/InsightJournalTemplate
3040

31-
# Keywords for indexing
32-
keywords:
33-
- open science
34-
- reproducible research
35-
- image processing
36-
- ITK
37-
- scientific computing
38-
- MyST markdown
39-
40-
abbreviations:
41-
FAIR: Findable, Accessible, Interoperable, and Reusable
42-
ITK: Insight Toolkit
43-
WASM: WebAssembly
44-
4541
# Publication venue
4642
venue:
4743
title: Insight Journal
4844
url: https://insight-journal.org
4945

50-
# Bibliography
51-
bibliography:
52-
- docs/references.bib
53-
5446
# Export configurations
5547
exports:
56-
- format: pdf
57-
template: arxiv_two_column
58-
article_type: research-article
48+
- format: typst
49+
template: lapreprint-typst
5950
output: exports/manuscript.pdf
6051
- format: pdf
61-
template: plain_latex_book
62-
output: exports/manuscript_book.pdf
63-
- format: meca
64-
output: exports/manuscript.meca.zip
52+
template: arxiv_nips
53+
article_type: research-article
54+
output: exports/arxiv.pdf
6555
- format: tex
66-
template: arxiv_two_column
56+
template: arxiv_nips
6757
output: exports/manuscript.tex
6858
- format: docx
6959
output: exports/manuscript.docx
60+
- format: cff
61+
- format: meca
62+
output: exports/manuscript.meca.zip
7063

7164
toc:
7265
- file: docs/index.md
@@ -76,6 +69,10 @@ project:
7669
- src/
7770
- data/
7871

72+
# Bibliography
73+
bibliography:
74+
- docs/references.bib
75+
7976
# Requirements for reproducibility
8077
requirements:
8178
- pixi.toml

pixi.toml

Lines changed: 11 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,8 @@
11
[project]
22
name = "insight-journal-template"
33
description = "A template for open science article submissions to the Insight Journal using MyST Markdown"
4-
authors = [
5-
"Galileo Galilei <[email protected]>",
6-
"Giordano Bruno <[email protected]>",
7-
"Anthony Leeuwenhoek <[email protected]>"
8-
]
94
channels = ["conda-forge"]
10-
platforms = ["linux-64", "osx-64", "osx-arm64", "win-64"]
5+
platforms = ["linux-64", "osx-arm64", "win-64"]
116

127
[dependencies]
138
# MyST ecosystem
@@ -20,39 +15,33 @@ numpy = "*"
2015
matplotlib = "*"
2116
scipy = "*"
2217

23-
# Document processing
24-
pandoc = "*"
25-
tectonic = "*"
26-
2718
# Development tools
2819
jupyterlab = "*"
2920

3021
# Optional: for notebook execution
3122
ipykernel = "*"
23+
typst = ">=0.13.1,<0.14"
3224

3325
[pypi-dependencies]
3426
# Image processing (ITK ecosystem)
3527
itk = "*"
3628
simpleitk = "*"
3729

3830
[tasks]
39-
# Build MyST documentation
4031
build-html = "myst build --html"
41-
build-pdf = "myst build --pdf"
42-
build-all = "myst build"
32+
build-pdf = "myst build --typst"
33+
build-arxiv = "myst build --pdf"
34+
build-tex = "myst build --tex"
35+
build-docx = "myst build --docx"
36+
build-cff = "myst build --cff"
37+
build-meca = "myst build --meca"
4338

4439
# Start development server
4540
serve = "myst start"
4641

4742
# Clean build artifacts
4843
clean = "myst clean"
4944

50-
# Export formats
51-
export-pdf = "myst build --pdf --template arxiv_two_column"
52-
export-arxiv = "myst build --pdf --template arxiv_two_column --output exports/arxiv.pdf"
53-
export-docx = "myst build --docx"
54-
export-meca = "myst build --meca"
55-
5645
# Development and testing
5746
dev = { depends-on = ["serve"] }
5847
lint = "myst check"
@@ -62,8 +51,9 @@ build-src = { cmd = "mkdir -p build && cd build && cmake ../src && make", cwd =
6251
test-src = { cmd = "cd build && ctest", cwd = ".", depends-on = ["build-src"] }
6352

6453
# Combined tasks
65-
build-paper = { depends-on = ["build-html", "export-pdf", "export-arxiv"] }
66-
build-complete = { depends-on = ["build-paper", "export-docx", "export-meca"] }
54+
build = { depends-on = ["build-html", "build-pdf", "build-tex", "build-docx", "build-cff", "build-meca"] }
55+
build-paper = { depends-on = ["build-html", "build-pdf", "build-arxiv"] }
56+
build-complete = { depends-on = ["build-paper", "build-tex", "build-docx", "build-cff", "build-meca"] }
6757

6858
[feature.cmake.dependencies]
6959
cmake = "*"
@@ -78,7 +68,3 @@ test-cmake = "cd build && ctest"
7868
[environments]
7969
default = { features = [], solve-group = "default" }
8070
dev = { features = ["cmake"], solve-group = "default" }
81-
82-
# Platform-specific dependencies
83-
[target.linux-64.dependencies]
84-
texlive-core = "*"

0 commit comments

Comments
 (0)