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.

Sign up for GitHub

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

Jump to bottom

added zenodo link to metadata table, explicit discussion of lockfiles/poetry #110

Merged
merged 5 commits into from
Oct 1, 2023
Merged

added zenodo link to metadata table, explicit discussion of lockfiles/poetry #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4811c40
add zenodo link to metadata table
paxtonfitzpatrick Oct 1, 2023
5ed215a
added zenodo link to meta-data table, added explicit discussion of lo…
jeremymanning Oct 1, 2023
00632e4
Merge branch 'ContextLab:main' into main
jeremymanning Oct 1, 2023
646da1b
recompile pdf to resolve merge conflict
paxtonfitzpatrick Oct 1, 2023
4513a3e
fixed poetry reference, removed duplicate from bib file
paxtonfitzpatrick Oct 1, 2023
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
Binary file modified paper/main.pdf
View file
Open in desktop
Binary file not shown.
19 changes: 15 additions & 4 deletions paper/main.tex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,15 +65,16 @@ \section*{Metadata}
\section*{Current code version}

\begin{table}[H]
\begin{tabular}{|l|p{6.5cm}|p{6.5cm}|}
\footnotesize
\begin{tabular}{|l|p{6cm}|p{8cm}|}
\hline
\textbf{Nr.} & \textbf{Code metadata description} & \textbf{Metadata value} \\
\hline
C1 & Current code version & v0.2.3 \\
\hline
C2 & Permanent link to code/repository used for this code version & \url{https://github.com/ContextLab/davos/tree/v0.2.3} \\
C2 & Permanent link to code/repository used for this code version & \url{https://doi.org/10.5281/zenodo.8233890} \\
\hline
C3 & Code Ocean compute capsule & \\
C3 & Code Ocean compute capsule & N/A\\
\hline
C4 & Legal Code License & MIT \\
\hline
Expand Down Expand Up @@ -994,7 +995,17 @@ \subsection{Pitfalls and limitations}
other standard Python package management systems such as \texttt{conda}~\cite{Anac12}.
Therefore packages that are not installable via \texttt{pip} are currently
unsupported by \texttt{Davos}. We anticipate adding support for other package management
systems, including \texttt{conda}, in a future release.
systems, including \texttt{conda}, in a future release. Because \texttt{Davos} relies on
\texttt{pip} to install packages, it is also subject to the same limitations as
\texttt{pip} itself. For example, \texttt{pip}-installing a package that depends on
a previously \texttt{smuggle}d package may result in the previously smuggled package
being upgraded or downgraded to a different version. Whereas lockfiles, or lockfile-based
systems like \texttt{Poetry}~\cite{Eust19}, place stronger guarantees that each package will
have a stable version, we have opted for a more flexible (but, consequently, less
deterministic) implementation for \texttt{Davos}. This enables us to support
more advanced use cases, such as those described in Section~\ref{sec:illustrative-example},
but at the cost of managing potential conflicts between \texttt{smuggle}d
packages.

A third limitation of \texttt{Davos} is that it cannot be used to manage projects that
depend on non-Python software. For example, system software or libraries from
Expand Down