Skip to content

Commit

Permalink
final updates
Browse files Browse the repository at this point in the history
  • Loading branch information
alanlujan91 committed Sep 30, 2024
1 parent 76b10e3 commit 39c2ca7
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 26 deletions.
Binary file modified report.docx
Binary file not shown.
10 changes: 6 additions & 4 deletions report.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,15 @@ acknowledgments: |

The Economics profession needs to catch up to other technical fields in software development, reproducibility practices, and "exchangeability" of results.

To that end, [Econ-ARK](https://econ-ark.org) has been working for several years on the [REMARK](https://github.com/econ-ark/REMARK) project, a set of standards and tools for reproducibility for computational modeling in economics. [REMARKs](https://econ-ark.org/materials/) are self-contained and complete projects whose contents should be executable by anyone on any modern computer (local or cloud), so long as the platform has the necessary hardware (generically described). A critical aspect of REMARKs is the emphasis on clear documentation, testing procedures, and standardized metadata to ensure that research outputs are reproducible, understandable, reusable, and securely attributable to their true authors.
To that end, [Econ-ARK](https://econ-ark.org) has been working for several years on the [REMARK](https://github.com/econ-ark/REMARK) project, a set of standards and tools for reproducibility for computational modeling in economics. [REMARKs](https://econ-ark.org/materials/) are self-contained and complete projects whose contents should be executable by anyone on any modern computer (local or cloud), so long as the platform has the necessary hardware (generically described)[^hardware]. A critical aspect of REMARKs is the emphasis on clear documentation, testing procedures, and standardized metadata to ensure that research outputs are reproducible, understandable, reusable, and securely attributable to their true authors.

[^hardware]: The hardware specification is inherently contingent on the specific computational task. However, REMARK aims to provide comprehensive instructions, enabling users to at least build the environment on any modern computer. While the execution of computationally intensive projects may necessitate specialized hardware, such as GPUs or extensive memory capacity, the software environment should remain universally accessible.

The design specs of the REMARK standard have been crafted with the collaboration of the editor of a projected journal that would require all submissions to abide by the REMARK standard.

While we have solved most of the computational challenges (using the blossoming ecosystem of tools including Docker containers, version control, etc.), one piece of the infrastructure needed to complete the specification is still lacking: A robust, reproducible, and portable standard for the production of the text of the paper (or other research product) that can directly integrate reproducible content.

The project sponsored by FossProf allowed us to hire an open-source contractor, [Curvenote](https://curvenote.com), to fill some crucial gaps in the infrastructure necessary to translate the standard medium of technical writing, $\LaTeX$, to the new world of lightweight, reproducible content. The bulk of the other FossProf funding allowed some JHU PhD students to create new examples of REMARKs that use these tools.
The project sponsored by FOSSProF allowed us to hire an open-source contractor, [Curvenote](https://curvenote.com), to fill some crucial gaps in the infrastructure necessary to translate the standard medium of technical writing, $\LaTeX$, to the new world of lightweight, reproducible content. The bulk of the other FOSSProF funding allowed some JHU PhD students to create new examples of REMARKs that use these tools.

### A brief history of REMARK

Expand Down Expand Up @@ -123,7 +125,7 @@ Third, we have continued to expand the catalog of existing REMARKs, including se

% Share any challenges encountered during the project and how you addressed them.

The project has gone quite smoothly, thanks to the deep expertise and strongly aligned goals of the REMARK project with the Myst project. The principal challenge is simply that making use of the new technologies requires an investment of time, which is the scarcest resource among busy scholars.
The project has gone quite smoothly, thanks to the deep expertise and strongly aligned goals of the REMARK project with the Myst project. **The principal challenge is simply that making use of the new technologies requires an investment of time, which is the scarcest resource among busy scholars.**

# Outcomes and Impact

Expand Down Expand Up @@ -178,7 +180,7 @@ This grant allowed us to host a workshop at the 30th International Conference fo

1. **Replication Competitions** - Competitions where researchers are challenged to replicate the results of notable papers, which will provide a practical demonstration of the REMARK standard and incentivize adoption.
2. **Tutorials and Workshops** - Target students and researchers to provide hands-on experience using our tools, demonstrating how to create reproducible research outputs and highlighting the advantages of open science.
3. **Talks** - Engage with journal editors and data editors to seek feedback and collaboration to understand better how our project can streamline the review process, ensure reproducibility, and enhance the credibility of published research.
3. **SCI-PASS Talks** - Engage with journal editors and data editors to seek feedback and collaboration to understand better how our project can streamline the review process, ensure reproducibility, and enhance the credibility of published research.

% ## Lessons Learned

Expand Down
Binary file modified report.pdf
Binary file not shown.
27 changes: 10 additions & 17 deletions report_pdf_logs/report.log
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
This is XeTeX, Version 3.141592653-2.6-0.999993 (TeX Live 2022/dev/Debian) (preloaded format=xelatex 2024.5.9) 29 SEP 2024 13:35
This is XeTeX, Version 3.141592653-2.6-0.999993 (TeX Live 2022/dev/Debian) (preloaded format=xelatex 2024.5.9) 30 SEP 2024 19:09
entering extended mode
\write18 enabled.
file:line:error style messages enabled.
Expand Down Expand Up @@ -638,6 +638,10 @@ LaTeX Font Info: External font `lmex10' loaded for size
(Font) <9> on input line 66.
LaTeX Font Info: External font `lmex10' loaded for size
(Font) <6> on input line 66.
[1


]
./report.tex:84: You can't use `\spacefactor' in math mode.
\@->\spacefactor
\@m {}
Expand All @@ -649,13 +653,6 @@ If you're in the wrong mode, you might be able to
return to the right one by typing `I}' or `I$' or `I\par'.

Missing character: There is no è ("E8) in font lmex10!

Underfull \vbox (badness 7963) has occurred while \output is active []

[1


]
LaTeX Font Info: Trying to load font information for T1+lmtt on input line 8
8.
(/usr/share/texmf/tex/latex/lm/t1lmtt.fd
Expand All @@ -665,15 +662,14 @@ Package microtype Info: Loading generic protrusion settings for font family
(microtype) `lmtt' (encoding: T1).
(microtype) For optimal results, create family-specific settings.
(microtype) See the microtype manual for details.

Underfull \hbox (badness 10000) in paragraph at lines 105--106

[]

Package microtype Info: Character `029' is missing
(microtype) in font `T1/lmr/m/sc/9'.
(microtype) Ignoring protrusion settings for this character.
[2]
Underfull \hbox (badness 10000) in paragraph at lines 105--106

[]

./report.tex:132: You can't use `\spacefactor' in math mode.
\@->\spacefactor
\@m {}
Expand Down Expand Up @@ -707,9 +703,6 @@ If you're in the wrong mode, you might be able to
return to the right one by typing `I}' or `I$' or `I\par'.

Missing character: There is no è ("E8) in font lmex10!

Underfull \vbox (badness 4660) has occurred while \output is active []

[3]
Underfull \hbox (badness 10000) in paragraph at lines 143--144

Expand Down Expand Up @@ -772,4 +765,4 @@ Here is how much of TeX's memory you used:
14 hyphenation exceptions out of 8191
70i,12n,76p,1224b,385s stack positions out of 5000i,500n,10000p,200000b,80000s

Output written on report.xdv (8 pages, 42384 bytes).
Output written on report.xdv (8 pages, 43092 bytes).
10 changes: 5 additions & 5 deletions report_pdf_tex/report.tex
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

\title{Reproducibility Standards for Economics}

\newdate{articleDate}{29}{9}{2024}
\newdate{articleDate}{30}{9}{2024}
\date{\displaydate{articleDate}}

\makeatletter
Expand Down Expand Up @@ -75,13 +75,13 @@ \subsection{Project Summary}

The Economics profession needs to catch up to other technical fields in software development, reproducibility practices, and ``exchangeability'' of results.

To that end, \href{https://econ-ark.org}{Econ-ARK} has been working for several years on the \href{https://github.com/econ-ark/REMARK}{REMARK} project, a set of standards and tools for reproducibility for computational modeling in economics. \href{https://econ-ark.org/materials/}{REMARKs} are self-contained and complete projects whose contents should be executable by anyone on any modern computer (local or cloud), so long as the platform has the necessary hardware (generically described). A critical aspect of REMARKs is the emphasis on clear documentation, testing procedures, and standardized metadata to ensure that research outputs are reproducible, understandable, reusable, and securely attributable to their true authors.
To that end, \href{https://econ-ark.org}{Econ-ARK} has been working for several years on the \href{https://github.com/econ-ark/REMARK}{REMARK} project, a set of standards and tools for reproducibility for computational modeling in economics. \href{https://econ-ark.org/materials/}{REMARKs} are self-contained and complete projects whose contents should be executable by anyone on any modern computer (local or cloud), so long as the platform has the necessary hardware (generically described)\footnote{The hardware specification is inherently contingent on the specific computational task. However, REMARK aims to provide comprehensive instructions, enabling users to at least build the environment on any modern computer. While the execution of computationally intensive projects may necessitate specialized hardware, such as GPUs or extensive memory capacity, the software environment should remain universally accessible.}. A critical aspect of REMARKs is the emphasis on clear documentation, testing procedures, and standardized metadata to ensure that research outputs are reproducible, understandable, reusable, and securely attributable to their true authors.

The design specs of the REMARK standard have been crafted with the collaboration of the editor of a projected journal that would require all submissions to abide by the REMARK standard.

While we have solved most of the computational challenges (using the blossoming ecosystem of tools including Docker containers, version control, etc.), one piece of the infrastructure needed to complete the specification is still lacking: A robust, reproducible, and portable standard for the production of the text of the paper (or other research product) that can directly integrate reproducible content.

The project sponsored by FossProf allowed us to hire an open-source contractor, \href{https://curvenote.com}{Curvenote}, to fill some crucial gaps in the infrastructure necessary to translate the standard medium of technical writing, $\LaTeX$, to the new world of lightweight, reproducible content. The bulk of the other FossProf funding allowed some JHU PhD students to create new examples of REMARKs that use these tools.
The project sponsored by FOSSProF allowed us to hire an open-source contractor, \href{https://curvenote.com}{Curvenote}, to fill some crucial gaps in the infrastructure necessary to translate the standard medium of technical writing, $\LaTeX$, to the new world of lightweight, reproducible content. The bulk of the other FOSSProF funding allowed some JHU PhD students to create new examples of REMARKs that use these tools.

\subsubsection{A brief history of REMARK}

Expand Down Expand Up @@ -181,7 +181,7 @@ \subsection{Challenges and Solutions}

% Share any challenges encountered during the project and how you addressed them.

The project has gone quite smoothly, thanks to the deep expertise and strongly aligned goals of the REMARK project with the Myst project. The principal challenge is simply that making use of the new technologies requires an investment of time, which is the scarcest resource among busy scholars.
The project has gone quite smoothly, thanks to the deep expertise and strongly aligned goals of the REMARK project with the Myst project. \textbf{The principal challenge is simply that making use of the new technologies requires an investment of time, which is the scarcest resource among busy scholars.}

\section{Outcomes and Impact}

Expand Down Expand Up @@ -238,7 +238,7 @@ \subsubsection{Taking REMARK/SCI-PASS on the road}
\begin{enumerate}
\item \textbf{Replication Competitions} - Competitions where researchers are challenged to replicate the results of notable papers, which will provide a practical demonstration of the REMARK standard and incentivize adoption.
\item \textbf{Tutorials and Workshops} - Target students and researchers to provide hands-on experience using our tools, demonstrating how to create reproducible research outputs and highlighting the advantages of open science.
\item \textbf{Talks} - Engage with journal editors and data editors to seek feedback and collaboration to understand better how our project can streamline the review process, ensure reproducibility, and enhance the credibility of published research.
\item \textbf{SCI-PASS Talks} - Engage with journal editors and data editors to seek feedback and collaboration to understand better how our project can streamline the review process, ensure reproducibility, and enhance the credibility of published research.
\end{enumerate}

% ## Lessons Learned
Expand Down

0 comments on commit 39c2ca7

Please sign in to comment.