teemi 0.2.0__tar.gz → 0.3.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (45) hide show
  1. {teemi-0.2.0 → teemi-0.3.2}/HISTORY.rst +11 -0
  2. teemi-0.3.2/PKG-INFO +556 -0
  3. {teemi-0.2.0 → teemi-0.3.2}/README.rst +202 -12
  4. {teemi-0.2.0 → teemi-0.3.2}/setup.cfg +1 -1
  5. {teemi-0.2.0 → teemi-0.3.2}/teemi/_version.py +3 -3
  6. {teemi-0.2.0 → teemi-0.3.2}/teemi/build/PCR.py +55 -57
  7. {teemi-0.2.0 → teemi-0.3.2}/teemi/build/robot_assembly.py +1 -1
  8. teemi-0.3.2/teemi/design/combinatorial_design.py +557 -0
  9. {teemi-0.2.0 → teemi-0.3.2}/teemi/design/fetch_sequences.py +19 -16
  10. teemi-0.3.2/teemi/design/gibson_cloning.py +337 -0
  11. teemi-0.3.2/teemi.egg-info/PKG-INFO +556 -0
  12. {teemi-0.2.0 → teemi-0.3.2}/teemi.egg-info/SOURCES.txt +1 -0
  13. {teemi-0.2.0 → teemi-0.3.2}/teemi.egg-info/entry_points.txt +0 -1
  14. teemi-0.2.0/PKG-INFO +0 -354
  15. teemi-0.2.0/teemi/design/combinatorial_design.py +0 -719
  16. teemi-0.2.0/teemi.egg-info/PKG-INFO +0 -354
  17. {teemi-0.2.0 → teemi-0.3.2}/AUTHORS.rst +0 -0
  18. {teemi-0.2.0 → teemi-0.3.2}/LICENSE +0 -0
  19. {teemi-0.2.0 → teemi-0.3.2}/MANIFEST.in +0 -0
  20. {teemi-0.2.0 → teemi-0.3.2}/setup.py +0 -0
  21. {teemi-0.2.0 → teemi-0.3.2}/teemi/__init__.py +0 -0
  22. {teemi-0.2.0 → teemi-0.3.2}/teemi/build/__init__.py +0 -0
  23. {teemi-0.2.0 → teemi-0.3.2}/teemi/build/containers_wells_picklists.py +0 -0
  24. {teemi-0.2.0 → teemi-0.3.2}/teemi/build/transformation.py +0 -0
  25. {teemi-0.2.0 → teemi-0.3.2}/teemi/design/CRISPRsequencecutter.py +0 -0
  26. {teemi-0.2.0 → teemi-0.3.2}/teemi/design/__init__.py +0 -0
  27. {teemi-0.2.0 → teemi-0.3.2}/teemi/design/cloning.py +0 -0
  28. {teemi-0.2.0 → teemi-0.3.2}/teemi/design/retrieve_gene_homologs.py +0 -0
  29. {teemi-0.2.0 → teemi-0.3.2}/teemi/design/sequence_finder.py +0 -0
  30. {teemi-0.2.0 → teemi-0.3.2}/teemi/design/teselagen_helpers.py +0 -0
  31. {teemi-0.2.0 → teemi-0.3.2}/teemi/learn/__init__.py +0 -0
  32. {teemi-0.2.0 → teemi-0.3.2}/teemi/learn/auto_ml.py +0 -0
  33. {teemi-0.2.0 → teemi-0.3.2}/teemi/learn/plotting.py +0 -0
  34. {teemi-0.2.0 → teemi-0.3.2}/teemi/lims/__init__.py +0 -0
  35. {teemi-0.2.0 → teemi-0.3.2}/teemi/lims/benchling_api.py +0 -0
  36. {teemi-0.2.0 → teemi-0.3.2}/teemi/lims/csv_database.py +0 -0
  37. {teemi-0.2.0 → teemi-0.3.2}/teemi/test/__init__.py +0 -0
  38. {teemi-0.2.0 → teemi-0.3.2}/teemi/test/data_wrangling.py +0 -0
  39. {teemi-0.2.0 → teemi-0.3.2}/teemi/test/genotyping.py +0 -0
  40. {teemi-0.2.0 → teemi-0.3.2}/teemi/utils.py +0 -0
  41. {teemi-0.2.0 → teemi-0.3.2}/teemi.egg-info/dependency_links.txt +0 -0
  42. {teemi-0.2.0 → teemi-0.3.2}/teemi.egg-info/not-zip-safe +0 -0
  43. {teemi-0.2.0 → teemi-0.3.2}/teemi.egg-info/requires.txt +0 -0
  44. {teemi-0.2.0 → teemi-0.3.2}/teemi.egg-info/top_level.txt +0 -0
  45. {teemi-0.2.0 → teemi-0.3.2}/versioneer.py +0 -0
@@ -14,3 +14,14 @@ History
14
14
 
15
15
  CRISPRSequenceCutter is a dataclass that is used to cut DNA through CRISPR-cas9 double-stranded break.
16
16
  SequenceFinder is a dataclass that finds upstream and downstream sequences from a sequence input, annotates them and saves them.
17
+
18
+
19
+ 0.3.0 (2023-22-06)
20
+ ------------------
21
+
22
+ * New submodules: gibson_cloning
23
+
24
+ This module is used to perform simple Gibson cloning workflows.
25
+ While the addition of the "gibson_cloning" submodule is an exciting development, this module is still a work in progress.
26
+ Next, a golden gate module. Keep posted on the progress.
27
+
teemi-0.3.2/PKG-INFO ADDED
@@ -0,0 +1,556 @@
1
+ Metadata-Version: 2.1
2
+ Name: teemi
3
+ Version: 0.3.2
4
+ Summary: A Python package for constructing microbial strains
5
+ Home-page: https://github.com/hiyama341/teemi
6
+ Author: Lucas Levassor
7
+ Author-email: lucaslevassor@gmail.com
8
+ License: MIT license
9
+ Keywords: teemi
10
+ Classifier: Development Status :: 2 - Pre-Alpha
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: License :: OSI Approved :: MIT License
13
+ Classifier: Natural Language :: English
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.8
16
+ Classifier: Programming Language :: Python :: 3.9
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Requires-Python: >=3.6
20
+ License-File: LICENSE
21
+ License-File: AUTHORS.rst
22
+
23
+ .. image:: https://raw.githubusercontent.com/hiyama341/teemi/main/pictures/teemi_logo.svg
24
+ :width: 400
25
+ :alt: teemi logo
26
+
27
+ teemi: a python package designed to make high-throughput strain construction reproducible and FAIR
28
+ --------------------------------------------------------------------------------------------------
29
+
30
+ .. summary-start
31
+
32
+ .. image:: https://badge.fury.io/py/teemi.svg
33
+ :target: https://badge.fury.io/py/teemi
34
+
35
+ .. image:: https://github.com/hiyama341/teemi/actions/workflows/main.yml/badge.svg
36
+ :target: https://github.com/hiyama341/teemi/actions
37
+
38
+ .. image:: https://readthedocs.org/projects/teemi/badge/?version=latest
39
+ :target: https://teemi.readthedocs.io/en/latest/?version=latest
40
+ :alt: Documentation Status
41
+
42
+ .. image:: https://img.shields.io/github/license/hiyama341/teemi
43
+ :target: https://github.com/hiyama341/teemi/blob/main/LICENSE
44
+
45
+ .. image:: https://img.shields.io/pypi/pyversions/teemi.svg
46
+ :target: https://pypi.org/project/teemi/
47
+ :alt: Supported Python Versions
48
+
49
+ .. image:: https://codecov.io/gh/hiyama341/teemi/branch/main/graph/badge.svg?token=P4457QACUY
50
+ :target: https://codecov.io/gh/hiyama341/teemi
51
+
52
+ .. image:: https://img.shields.io/badge/code%20style-black-black
53
+ :target: https://black.readthedocs.io/en/stable/
54
+
55
+ .. image:: https://img.shields.io/github/last-commit/hiyama341/teemi
56
+
57
+ .. image:: https://img.shields.io/badge/DOI-10_1101_2023_06_18_545451
58
+ :target: https://doi.org/10.1101/2023.06.18.545451
59
+
60
+
61
+
62
+ What is teemi?
63
+ ~~~~~~~~~~~~~~
64
+
65
+ **teemi**, named after the Greek goddess of fairness, is a python package designed
66
+ to make microbial strain construction reproducible and FAIR (Findable, Accessible,
67
+ Interoperable, and Reusable). With teemi, you can simulate all steps of
68
+ a strain construction cycle, from generating genetic parts to designing
69
+ a combinatorial library and keeping track of samples through a commercial
70
+ Benchling API and a low-level CSV file database.
71
+ This tool can be used in literate programming to
72
+ increase efficiency and speed in metabolic engineering tasks.
73
+ To try teemi, visit our `Google Colab notebooks <https://github.com/hiyama341/teemi/tree/main/colab_notebooks>`__.
74
+
75
+
76
+ teemi not only simplifies the strain construction process but also offers the
77
+ flexibility to adapt to different experimental workflows through its open-source
78
+ Python platform. This allows for efficient automation of repetitive tasks and
79
+ a faster pace in metabolic engineering.
80
+
81
+ Our demonstration of teemi in a complex machine learning-guided
82
+ metabolic engineering task showcases its efficiency
83
+ and speed by debottlenecking a crucial step in the strictosidine pathway.
84
+ This highlights the versatility and usefulness of this tool in various
85
+ biological applications.
86
+
87
+ Curious about how you can build strains easier and faster with teemi?
88
+ Head over to our `Google Colab notebooks <https://github.com/hiyama341/teemi/tree/main/colab_notebooks>`__
89
+ and give it a try.
90
+
91
+ Our pre-print `"Literate programming for iterative design-build-test-learn cycles in bioengineering" <https://www.biorxiv.org/content/10.1101/2023.06.18.545451v1>`__ is out now.
92
+ Please cite it if you've used teemi in a scientific publication.
93
+
94
+ .. summary-end
95
+
96
+
97
+ Features
98
+ --------
99
+
100
+ * Combinatorial library generation
101
+ * HT cloning and transformation workflows
102
+ * Flowbot One instructions
103
+ * CSV-based LIMS system as well as integration to Benchling
104
+ * Genotyping of microbial strains
105
+ * Advanced Machine Learning of biological datasets with the AutoML `H2O <https://docs.h2o.ai/h2o/latest-stable/h2o-docs/automl.html>`__
106
+ * Workflows for selecting enzyme homologs
107
+ * Promoter selection workflows from RNA-seq datasets
108
+ * Data analysis of large LC-MS datasets along with workflows for analysis
109
+
110
+
111
+ Getting started
112
+ ~~~~~~~~~~~~~~~
113
+ To get started with making microbial strains in an HT manner please follow the steps below:
114
+
115
+ 1. Install teemi. You will find the necessary information below for installation.
116
+
117
+ 2. Check out our `notebooks <https://github.com/hiyama341/teemi/tree/main/colab_notebooks>`__ for inspiration to make HT strain construction with teemi.
118
+
119
+ 3. You can start making your own workflows by importing teemi into either Google colab or Jupyter lab/notebooks.
120
+
121
+
122
+ Colab notebooks
123
+ ---------------
124
+ As a proof of concept we show how teemi and literate programming can be used to streamline bioengineering workflows.
125
+ These workflows should serve as a guide or a help to build your own workflows and thereby harnessing the power of literate programming with teemi.
126
+
127
+ Specifically, in this study we present how teemi and literate programming to build simulation-guided, iterative,
128
+ and evolution-guided laboratory workflows for optimizing strictosidine production in yeast.
129
+
130
+ Below you can find all the notebooks developed in this work.
131
+ Just click the Google colab badge to start the workflows.
132
+
133
+
134
+ A Quick Guide to Creating a Combinatorial Library
135
+ -------------------------------------------------
136
+
137
+ This guide provides a simple illustration of the power and ease of use of the Teemi tool. Let's take the example of creating a basic combinatorial library with the following design considerations:
138
+
139
+ - Four promoters
140
+ - Ten enzyme homologs
141
+ - A Kozak sequence integrated into the primers
142
+
143
+ Our goal is to assemble a library of promoters and enzymes into a genome via in vivo assembly. We already have a CRISPR plasmid; all we need to do is amplify the promoters and enzymes for the transformation. This requires generating primers and conducting numerous PCRs. We'll use Teemi for this process.
144
+
145
+ To begin, we load the genetic parts using Teemi's easy-to-use function ``read_genbank_files()``, specifying the path to the genetic parts.
146
+
147
+ .. code-block:: python
148
+
149
+ from teemi.design.fetch_sequences import read_genbank_files
150
+ path = '../data/genetic_parts/G8H_CYP_CPR_PARTS/'
151
+ pCPR_sites = read_genbank_files(path+'CPR_promoters.gb')
152
+ CPR_sites = read_genbank_files(path+'CPR_tCYC1.gb')
153
+
154
+ We have four promoters and ten CPR homologs (all with integrated terminators). We want to convert them into ``pydna.Dseqrecord`` objects from their current form as ``Bio.Seqrecord``. We can do it this way:
155
+
156
+ .. code-block:: python
157
+
158
+ from pydna.dseqrecord import Dseqrecord
159
+ pCPR_sites = [Dseqrecord(seq) for seq in pCPR_sites]
160
+ CPR_sites = [Dseqrecord(seq) for seq in CPR_sites]
161
+
162
+ Next, we add these genetic parts to a list in the configuration we desire, with the promoters upstream of the enzyme homologs.
163
+
164
+ .. code-block:: python
165
+
166
+ list_of_seqs = [pCPR_sites, CPR_sites]
167
+
168
+ If we want to integrate a sgRNA site into the primers, we can do that. In this case, we want to integrate a Kozak sequence.
169
+ We can initialize it as shown below.
170
+
171
+ .. code-block:: python
172
+
173
+ kozak = [Dseqrecord('TCGGTC')]
174
+
175
+ Now we're ready to create a combinatorial library of our 4x10 combinations. We can import the Teemi class for this.
176
+
177
+ .. code-block:: python
178
+
179
+ from teemi.design.combinatorial_design import DesignAssembly
180
+
181
+ We initialize with the sequences, the pad (where we want the pad - in this case, between the promoters and CPRs), then select the overlap and the desired temperature for the primers. Note that you can use your own primer calculator. Teemi has a function that can calculate primer Tm using NEB, for example, but for simplicity, we'll use the default calculator here.
182
+
183
+ .. code-block:: python
184
+
185
+ CPR_combinatorial_library = DesignAssembly(list_of_seqs, pad = kozak , position_of_pads =[1], overlap=35, target_tm = 55 )
186
+
187
+ Now, we can retrieve the library.
188
+
189
+ .. code-block:: python
190
+
191
+ CPR_combinatorial_library.primer_list_to_dataframe()
192
+
193
+
194
+ .. list-table::
195
+ :widths: 5 10 15 10 5 10 15 15 10
196
+ :header-rows: 1
197
+
198
+ * - id
199
+ - anneals to
200
+ - sequence
201
+ - annealing temperature
202
+ - length
203
+ - price(DKK)
204
+ - description
205
+ - footprint
206
+ - len_footprint
207
+ * - P001
208
+ - pMLS1
209
+ - ...
210
+ - 56.11
211
+ - 20
212
+ - 36.0
213
+ - Anneals to pMLS1
214
+ - ...
215
+ - 20
216
+ * - P002
217
+ - pMLS1
218
+ - ...
219
+ - 56.18
220
+ - 49
221
+ - 88.2
222
+ - Anneals to pMLS1, overlaps to 2349bp_PCR_prod
223
+ - ...
224
+ - 28
225
+ * - ...
226
+ - ...
227
+ - ...
228
+ - ...
229
+ - ...
230
+ - ...
231
+ - ...
232
+ - ...
233
+ - ...
234
+
235
+ The result of this operation is a pandas DataFrame which will look similar to the given example (note that the actual DataFrame have more rows).
236
+
237
+
238
+ To obtain a DataFrame detailing the steps required for each PCR, we can use the following:
239
+
240
+ .. code-block:: python
241
+
242
+ CPR_combinatorial_library.pcr_list_to_dataframe()
243
+ .. list-table::
244
+ :widths: 10 20 15 15 10 10
245
+ :header-rows: 1
246
+
247
+ * - pcr_number
248
+ - template
249
+ - forward_primer
250
+ - reverse_primer
251
+ - f_tm
252
+ - r_tm
253
+ * - PCR1
254
+ - pMLS1
255
+ - P001
256
+ - P002
257
+ - 56.11
258
+ - 56.18
259
+ * - PCR2
260
+ - AhuCPR_tCYC1
261
+ - P003
262
+ - P004
263
+ - 53.04
264
+ - 53.50
265
+ * - PCR3
266
+ - pMLS1
267
+ - P001
268
+ - P005
269
+ - 56.11
270
+ - 56.18
271
+ * - ...
272
+ - ...
273
+ - ...
274
+ - ...
275
+ - ...
276
+ - ...
277
+
278
+
279
+ The output is a pandas DataFrame. This is a simplified version and the actual DataFrame can have more rows.
280
+
281
+ Teemi has many more functionalities. For instance, we can easily view the different combinations in our library.
282
+
283
+ .. code-block:: python
284
+
285
+ CPR_combinatorial_library.show_variants_lib_df()
286
+
287
+ .. list-table::
288
+ :widths: 5 15 10 5
289
+ :header-rows: 1
290
+
291
+ * - 0
292
+ - 1
293
+ - Systematic_name
294
+ - Variant
295
+ * - pMLS1
296
+ - AhuCPR_tCYC1
297
+ - (1, 1)
298
+ - 0
299
+ * - pMLS1
300
+ - AanCPR_tCYC1
301
+ - (1, 2)
302
+ - 1
303
+ * - pMLS1
304
+ - CloCPR_tCYC1
305
+ - (1, 3)
306
+ - 2
307
+ * - ...
308
+ - ...
309
+ - ...
310
+ - ...
311
+
312
+
313
+ This command results in a pandas DataFrame, showing the combinations in the library. This is a simplified version and the actual DataFrame would have 40 rows for this example.
314
+
315
+ The next step is to head to the lab and build some strains. Luckily, we have many examples demonstrating how to do this for a large number of strains and a bigger library (1280 combinations).
316
+ Please refer to our notebooks below where we look at optimizing strictosidine production in yeast with Teemi.
317
+
318
+
319
+ Strictosidine case : First DBTL cycle
320
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
321
+
322
+ **DESIGN:**
323
+
324
+ .. |Notebook 00| image:: https://colab.research.google.com/assets/colab-badge.svg
325
+ :alt: Notebook 00
326
+ :target: https://colab.research.google.com/github/hiyama341/teemi/blob/main/colab_notebooks/00_1_DESIGN_Homologs.ipynb
327
+
328
+ .. |Notebook 01| image:: https://colab.research.google.com/assets/colab-badge.svg
329
+ :alt: Notebook 01
330
+ :target: https://colab.research.google.com/github/hiyama341/teemi/blob/main/colab_notebooks/01_1_DESIGN_Promoters.ipynb
331
+
332
+ .. |Notebook 02| image:: https://colab.research.google.com/assets/colab-badge.svg
333
+ :alt: Notebook 02
334
+ :target: https://colab.research.google.com/github/hiyama341/teemi/blob/main/colab_notebooks/02_1_DESIGN_Combinatorial_library.ipynb
335
+
336
+
337
+ 1. Automatically fetch homologs from NCBI from a query in a standardizable and repeatable way
338
+
339
+ |Notebook 00|
340
+
341
+
342
+ 01. Promoters can be selected from RNAseq data and fetched from online database with various quality measurements implemented
343
+
344
+ |Notebook 01|
345
+
346
+
347
+
348
+ 02. Combinatorial libraries can be generated with the DesignAssembly class along with robot executable intructions
349
+
350
+ |Notebook 02|
351
+
352
+
353
+
354
+
355
+ **BUILD:**
356
+
357
+ .. |Notebook 03| image:: https://colab.research.google.com/assets/colab-badge.svg
358
+ :alt: Notebook 03
359
+ :target: https://colab.research.google.com/github/hiyama341/teemi/blob/main/colab_notebooks/03_1_BUILD_gRNA_plasmid.ipynb
360
+
361
+
362
+ .. |Notebook 04| image:: https://colab.research.google.com/assets/colab-badge.svg
363
+ :alt: Notebook 04
364
+ :target: https://colab.research.google.com/github/hiyama341/teemi/blob/main/colab_notebooks/04_1_BUILD_Background_strain.ipynb
365
+
366
+
367
+ .. |Notebook 05| image:: https://colab.research.google.com/assets/colab-badge.svg
368
+ :alt: Notebook 05
369
+ :target: https://colab.research.google.com/github/hiyama341/teemi/blob/main/colab_notebooks/05_1_BUILD_Combinatorial_library.ipynb
370
+
371
+
372
+ 03. Assembly of a CRISPR plasmid with USER cloning
373
+
374
+ |Notebook 03|
375
+
376
+ 04. Construction of the background strain by K/O of G8H and CPR
377
+
378
+ |Notebook 04|
379
+
380
+ 05. First combinatorial library was generated for 1280 possible combinations
381
+
382
+ |Notebook 05|
383
+
384
+
385
+
386
+ **TEST:**
387
+
388
+
389
+ .. |Notebook 06| image:: https://colab.research.google.com/assets/colab-badge.svg
390
+ :alt: Notebook 06
391
+ :target: https://colab.research.google.com/github/hiyama341/teemi/blob/main/colab_notebooks/06_1_TEST_Library_characterisation.ipynb
392
+
393
+
394
+ 06. Data processing of LC-MS data and genotyping of the generated strains
395
+
396
+ |Notebook 06|
397
+
398
+
399
+ **LEARN:**
400
+
401
+ .. |Notebook 07| image:: https://colab.research.google.com/assets/colab-badge.svg
402
+ :alt: Notebook 07
403
+ :target: https://colab.research.google.com/github/hiyama341/teemi/blob/main/colab_notebooks/07_1_LEARN_Modelling_and_predictions.ipynb
404
+
405
+
406
+ 07. Use AutoML to predict the best combinations for a targeted second round of library construction
407
+
408
+ |Notebook 07|
409
+
410
+
411
+
412
+ Strictosidine case : Second DBTL cycle
413
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
414
+
415
+
416
+
417
+ **DESIGN:**
418
+
419
+ .. |Notebook 08| image:: https://colab.research.google.com/assets/colab-badge.svg
420
+ :alt: Notebook 08
421
+ :target: https://colab.research.google.com/github/hiyama341/teemi/blob/main/colab_notebooks/08_2_DESIGN_Model_recommended_combinatiorial_library.ipynb
422
+
423
+ 08. Results from the ML can be translated into making a targeted library of strains
424
+
425
+ |Notebook 08|
426
+
427
+
428
+
429
+ **BUILD:**
430
+
431
+
432
+ .. |Notebook 09| image:: https://colab.research.google.com/assets/colab-badge.svg
433
+ :alt: Notebook 09
434
+ :target: https://colab.research.google.com/github/hiyama341/teemi/blob/main/colab_notebooks/09_2_BUILD_Combinatorial_library.ipynb
435
+
436
+
437
+ 09. Shows the construction of a targeted library of strains
438
+
439
+ |Notebook 09|
440
+
441
+
442
+
443
+
444
+ **TEST:**
445
+
446
+ .. |Notebook 10| image:: https://colab.research.google.com/assets/colab-badge.svg
447
+ :alt: Notebook 10
448
+ :target: https://colab.research.google.com/github/hiyama341/teemi/blob/main/colab_notebooks/10_2_TEST_Library_characterization.ipynb
449
+
450
+
451
+
452
+ 10. Data processing of LC-MS data like in notebook 6
453
+
454
+ |Notebook 10|
455
+
456
+
457
+
458
+
459
+ **LEARN:**
460
+
461
+ .. |Notebook 11| image:: https://colab.research.google.com/assets/colab-badge.svg
462
+ :alt: Notebook 11
463
+ :target: https://colab.research.google.com/github/hiyama341/teemi/blob/main/colab_notebooks/11_2_LEARN_Modelling_and_predictions.ipynb
464
+
465
+
466
+ 11. Second ML cycle of ML showing how the model increased performance and saturation of best performing strains
467
+
468
+ |Notebook 11|
469
+
470
+
471
+
472
+ Installation
473
+ ~~~~~~~~~~~~
474
+
475
+ .. installation-start
476
+
477
+ Use pip to install teemi from `PyPI <https://pypi.org/project/teemi/>`__.
478
+
479
+ ::
480
+
481
+ $ pip install teemi
482
+
483
+
484
+ If you want to develop or if you cloned the repository from our `GitHub <https://github.com/hiyama341/teemi/>`__
485
+ you can install teemi in the following way.
486
+
487
+ ::
488
+
489
+ $ pip install -e <path-to-teemi-repo>
490
+
491
+
492
+ You might need to run these commands with administrative
493
+ privileges if you're not using a virtual environment (using ``sudo`` for example).
494
+ Please check the `documentation <https://teemi.readthedocs.io/en/latest/installation.html#>`__
495
+ for further details.
496
+
497
+ .. installation-end
498
+
499
+ Documentation and Examples
500
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~
501
+
502
+ Documentation is available on through numerous Google Colab notebooks with
503
+ examples on how to use teemi and how we use these notebooks for strain
504
+ construnction. The Colab notebooks can be found here
505
+ `teemi.notebooks <https://github.com/hiyama341/teemi/tree/main/colab_notebooks>`__.
506
+
507
+ * Documentation: https://teemi.readthedocs.io.
508
+
509
+
510
+ Contributions
511
+ ~~~~~~~~~~~~~
512
+
513
+ Contributions are very welcome! Check our `guidelines <https://teemi.readthedocs.io/en/latest/contributing.html>`__ for instructions how to contribute.
514
+
515
+
516
+ License
517
+ ~~~~~~~
518
+ * Free software: MIT license
519
+
520
+ Credits
521
+ -------
522
+ - This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
523
+
524
+ .. _Cookiecutter: https://github.com/audreyr/cookiecutter
525
+
526
+ .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
527
+
528
+ - teemis logo was made by Jonas Krogh Fischer. Check out his `website <http://jkfischerproductions.com/kea/portfolio/index.html>`__.
529
+
530
+ History
531
+ -------
532
+
533
+ 0.1.0 (2023-01-02)
534
+ ------------------
535
+
536
+ * First release on PyPI.
537
+
538
+
539
+ 0.2.0 (2023-31-05)
540
+ ------------------
541
+
542
+ * New submodules: CRISPRsequencecutter, sequence_finder.
543
+
544
+ CRISPRSequenceCutter is a dataclass that is used to cut DNA through CRISPR-cas9 double-stranded break.
545
+ SequenceFinder is a dataclass that finds upstream and downstream sequences from a sequence input, annotates them and saves them.
546
+
547
+
548
+ 0.3.0 (2023-22-06)
549
+ ------------------
550
+
551
+ * New submodules: gibson_cloning
552
+
553
+ This module is used to perform simple Gibson cloning workflows.
554
+ While the addition of the "gibson_cloning" submodule is an exciting development, this module is still a work in progress.
555
+ Next, a golden gate module. Keep posted on the progress.
556
+