about summary refs log tree commit diff
path: root/README.md
diff options
context:
space:
mode:
authorPjotr Prins2026-03-27 13:15:58 +0100
committerPjotr Prins2026-03-27 13:15:58 +0100
commitf6e63d3d53a3f4c03c646ccadf718920a0a1095e (patch)
tree2f7fc652c2238e0fbe17f2117e9df18c69a441b1 /README.md
parent643bb3f622da68b109f3a99524713c8c1e66239b (diff)
downloadgenecup-f6e63d3d53a3f4c03c646ccadf718920a0a1095e.tar.gz
Make sure paths are available
Diffstat (limited to 'README.md')
-rw-r--r--README.md40
1 files changed, 31 insertions, 9 deletions
diff --git a/README.md b/README.md
index 08676b3..fa0f54f 100644
--- a/README.md
+++ b/README.md
@@ -25,10 +25,40 @@ Live searches are conducted through PubMed to get relevant PMIDs, which are then
 3. sort the genes based on the number of abstracts with useful sentences.
 4. generate the final list, include symbol, alias, and name
 
+# Run a test server
+
+You can use the [guix.scm](./guix.scm) container to run genecup:
+
+```sh
+env GEMINI_API_KEY="AIzaSy**" `guix build -L . genecup-gemini`/server.py --port 4201
+```
+
+Note that the build includes minipubmed and punkt for testing!
+
+# Run a production server
+
 ## Install local mirror of PubMed
 
 - Following the instruction provided by NCBI: https://www.nlm.nih.gov/dataguide/edirect/archive.html
 
+Point environment variables to this dir.
+
+```
+env EDIRECT_PUBMED_MASTER=/export3/PubMed GEMINI_API_KEY="AIzaSy**" `guix build -L . genecup-gemini`/server.py --port 4201
+```
+
+Environment variables used:
+
+```
+EDIRECT_PUBMED_MASTER
+GEMINI_API_KEY
+NLTK_DATA
+TMPDIR
+```
+
+# Development
+
+
 ## Mini PubMed for testing
 
 For testing or code development, it is useful to have a small collection of PubMed abstracts in the same format as the local PubMed mirror. We provide 2473 abstracts that can be used to test four gene symbols (gria1, crhr1, drd2, and penk).
@@ -56,15 +86,7 @@ wget https://raw.githubusercontent.com/nltk/nltk_data/gh-pages/packages/tokenize
 unzip punkt.zip
 ```
 
-# Run the server
-
-You can use the [guix.scm](./guix.scm) container to run genecup:
-
-```sh
-GeneCup$ guix shell -L . -C -N -F genecup-gemini coreutils edirect -- env EDIRECT_PUBMED_MASTER=./minipubmed NLTK_DATA=./minipubmed GEMINI_API_KEY="AIza****" ./server.py --port 4201
-```
-
-## Development
+## Source code
 
 The source code and data are in a git repository: https://git.genenetwork.org/genecup/