Skip to content

Commit a09e518

Browse files
authored
feat: update seqrepo and uta version to 20241220 (#400)
close #399 * Update default value for `UTA_DB_URL` to point to latest UTA version
1 parent de3d5c0 commit a09e518

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

docs/source/install.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,11 +40,11 @@ Cool-Seq-Tool requires an available instance of the Universal Transcript Archive
4040
createuser -U postgres anonymous
4141
createdb -U postgres -O uta_admin uta
4242
43-
export UTA_VERSION=uta_20210129b.pgd.gz # most recent as of 2023/12/05
43+
export UTA_VERSION=uta_20241220.pgd.gz # most recent as of 2025/03/10
4444
curl -O https://dl.biocommons.org/uta/$UTA_VERSION
4545
gzip -cdq ${UTA_VERSION} | psql -h localhost -U uta_admin --echo-errors --single-transaction -v ON_ERROR_STOP=1 -d uta -p 5432
4646
47-
By default, Cool-Seq-Tool expects to connect to the UTA database via a PostgreSQL connection served local on port 5432, under the PostgreSQL username ``uta_admin`` and the schema ``uta_20210129b``.
47+
By default, Cool-Seq-Tool expects to connect to the UTA database via a PostgreSQL connection served local on port 5432, under the PostgreSQL username ``uta_admin`` and the schema ``uta_20241220``.
4848

4949
Set up SeqRepo
5050
--------------
@@ -56,20 +56,20 @@ Cool-Seq-Tool requires access to `SeqRepo <https://github.com/biocommons/biocomm
5656
.. code-block::
5757
5858
pip install seqrepo
59-
export SEQREPO_VERSION=2024-02-20
59+
export SEQREPO_VERSION=2024-12-20
6060
sudo mkdir /usr/local/share/seqrepo
6161
sudo chown $USER /usr/local/share/seqrepo
6262
seqrepo pull -i $SEQREPO_VERSION
6363
6464
.. note::
6565

66-
Our lab typically uses the latest SeqRepo release, which is ``2024-02-20`` as of this commit. To check for the presence of newer snapshots, use the ``seqrepo list-remote-instances`` CLI command.
66+
Our lab typically uses the latest SeqRepo release, which is ``2024-12-20`` as of this commit. To check for the presence of newer snapshots, use the ``seqrepo list-remote-instances`` CLI command.
6767

6868
While this should no longer occur with the latest SeqRepo release, some users in the past have reported experiencing the following error:
6969

7070
.. code-block::
7171
72-
PermissionError: [Error 13] Permission denied: '/usr/local/share/seqrepo/2024-02-20._fkuefgd' -> '/usr/local/share/seqrepo/2021-01-29'
72+
PermissionError: [Error 13] Permission denied: '/usr/local/share/seqrepo/2024-12-20._fkuefgd' -> '/usr/local/share/seqrepo/2024-12-20'
7373
7474
Try moving data manually with ``sudo``:
7575

docs/source/usage.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Individual classes will accept arguments upon initialization to set parameters r
8080
* - ``SEQREPO_ROOT_DIR``
8181
- Path to SeqRepo directory (i.e. contains ``aliases.sqlite3`` database file, and ``sequences`` directory). Used by :py:class:`SeqRepoAccess <cool_seq_tool.handlers.seqrepo_access.SeqRepoAccess>`. If not defined, defaults to ``/usr/local/share/seqrepo/latest``.
8282
* - ``UTA_DB_URL``
83-
- A `libpq connection string <https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING>`_, i.e. of the form ``postgresql://<user>:<password>@<host>:<port>/<database>/<schema>``, used by the :py:class:`UtaDatabase <cool_seq_tool.sources.uta_database.UtaDatabase>` class. By default, it is set to ``postgresql://uta_admin:uta@localhost:5432/uta/uta_20210129b``.
83+
- A `libpq connection string <https://www.postgresql.org/docs/current/libpq-connect.html#LIBPQ-CONNSTRING>`_, i.e. of the form ``postgresql://<user>:<password>@<host>:<port>/<database>/<schema>``, used by the :py:class:`UtaDatabase <cool_seq_tool.sources.uta_database.UtaDatabase>` class. By default, it is set to ``postgresql://uta_admin:uta@localhost:5432/uta/uta_20241220``.
8484
* - ``LIFTOVER_CHAIN_37_TO_38``
8585
- A path to a `chainfile <https://genome.ucsc.edu/goldenPath/help/chain.html>`_ for lifting from GRCh37 to GRCh38. Used by the :py:class:`LiftOver <cool_seq_tool.mappers.liftover.LiftOver>` class as input to `agct <https://pypi.org/project/agct/>`_. If not provided, agct will fetch it automatically from UCSC.
8686
* - ``LIFTOVER_CHAIN_38_TO_37``

src/cool_seq_tool/sources/uta_database.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
UTADatabaseType = TypeVar("UTADatabaseType", bound="UtaDatabase")
2828

2929
UTA_DB_URL = environ.get(
30-
"UTA_DB_URL", "postgresql://uta_admin:uta@localhost:5432/uta/uta_20210129b"
30+
"UTA_DB_URL", "postgresql://uta_admin:uta@localhost:5432/uta/uta_20241220"
3131
)
3232

3333
_logger = logging.getLogger(__name__)

0 commit comments

Comments
 (0)