Logbook updates

pythonhealthdatascience · Jun 11, 2024 · c5edec1 · c5edec1
1 parent e211807
commit c5edec1
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/logbook/posts/2024_06_10/index.qmd b/logbook/posts/2024_06_10/index.qmd
@@ -30,4 +30,5 @@ Continued working on research compendium...
     * After rebuilding the container, ran using `sudo docker run -it -p 8080:80 --name covid19_docker covid19`, then did the commands `conda activate covid19` and `jupyter-lab`
     * Opened browser and entered `localhost:8080`
     * Succesfully ran `reproduction.ipynb`
-* Uploaded image to GitHub container registry (<https://github.com/features/packages>) - using this instead of DockerHub as it means the image can be associated with an organisation (whilst DockerHub requires payment for organisations) - and pushed using GitHub action (as had issues trying to push from terminal with my user's personal access token)
+* Uploaded image to GitHub container registry (<https://github.com/features/packages>) - using this instead of DockerHub as it means the image can be associated with an organisation (whilst DockerHub requires payment for organisations) - and pushed using GitHub action (as had issues trying to push from terminal with my user's personal access token)
+    * Issue: Shows README from main repo with customisation options - this is not resolvable, and is an [open issue on GitHub](https://github.com/orgs/community/discussions/25665)
diff --git a/logbook/posts/2024_06_11/index.qmd b/logbook/posts/2024_06_11/index.qmd
@@ -89,4 +89,18 @@ python-3.8.1
 
 **Conclusion:** Decided that for the purposes of these reproduction assessments, to not continue pursuing this at the current moment in time, and to just keep with the options of the environment file or the Binder image (locally or from GHCR).
 
-#### Other aspects of research compendium
+#### Other aspects of research compendium
+
+README:
+
+* Add operating system (found by running `cat /etc/os-release`, `lscpu` and `free -g` (to see RAM in GB))
+* Recorded runtime (with measurement of time elapsed added to the notebook)
+* Add model summary (copied from final report, with addition of the pathway figure)
+* Add reproduction scope (copied from `scope.qmd`)
+* Created repository overview
+* Tidied instructions on environment set up and running the model
+* Add some extra details on citation and license.
+
+Notebook:
+
+* Made some minor additions, but primarily referred back to the `README.md`