Hướng dẫn biopython github - biopython github

Hướng dẫn biopython github - biopython github
Hướng dẫn biopython github - biopython github

Tệp Biopython Readme

Dự án Biopython là một hiệp hội quốc tế gồm các nhà phát triển các công cụ Python có sẵn miễn phí cho sinh học phân tử tính toán.

Tài liệu tập trung vào người dùng của chúng tôi được lưu trữ trên https://biopython.org bao gồm tài liệu API của chúng tôi và hướng dẫn và sách dạy nấu ăn chính của chúng tôi (PDF).

Tệp README này chủ yếu dành cho những người quan tâm đến việc làm việc với mã nguồn Biopython, một trong những bản phát hành từ trang web http://biopython.org hoặc từ kho lưu trữ của chúng tôi trên GitHub https://github.com/biopython/biopy

Tệp tin tức tóm tắt những thay đổi trong mỗi bản phát hành Biopython.

Gói Biopython là phần mềm nguồn mở được cung cấp theo các điều khoản hào phóng. Vui lòng xem tập tin giấy phép để biết thêm chi tiết.

Nếu bạn sử dụng Biopython trong công việc đóng góp cho một ấn phẩm khoa học, chúng tôi yêu cầu bạn trích dẫn ghi chú ứng dụng của chúng tôi (bên dưới) hoặc một trong các ấn phẩm cụ thể của mô -đun (được liệt kê trên trang web của chúng tôi):

Cock, P.J.A. et al. Biopython: Các công cụ Python có sẵn miễn phí cho sinh học phân tử tính toán và tin sinh học. Tin sinh học 2009 ngày 1 tháng 6; 25 (11) 1422-3 https://doi.org/10.1093/bioinformatics/BTP163 PMID: 19304878

Cho người thiếu kiên nhẫn

Python bao gồm hệ thống quản lý gói "PIP" cho phép bạn cài đặt Biopython (và sự phụ thuộc của nó nếu cần), nâng cấp hoặc gỡ cài đặt chỉ bằng một lệnh đầu cuối:

pip install biopython
pip install --upgrade biopython
pip uninstall biopython

Kể từ Biopython 1.70, chúng tôi đã cung cấp các gói bánh xe nhị phân được biên dịch sẵn trên PYPI cho Linux, Mac OS X và Windows. Điều này có nghĩa là cài đặt PIP phải nhanh chóng và không yêu cầu trình biên dịch.

Là nhà phát triển hoặc người đóng góp tiềm năng, bạn có thể muốn tải xuống, xây dựng và tự cài đặt Biopython. Điều này được mô tả dưới đây.

Yêu cầu Python

Chúng tôi hiện khuyên bạn nên sử dụng Python 3.9 từ http://www.python.org

Biopython hiện đang được hỗ trợ và thử nghiệm về các triển khai Python sau:

  • Python 3.7, 3.8, 3.9 và 3.10 - Xem http://www.python.org
  • Pypy3.7 v7.3.5 - hoặc muộn hơn, xem http://www.pypy.org

Phụ thuộc tùy chọn

Biopython yêu cầu Numpy (xem http://www.numpy.org) sẽ được cài đặt tự động nếu bạn cài đặt Biopython với PIP (xem bên dưới để tự biên dịch Biopython).

Tùy thuộc vào phần nào của Biopython bạn dự định sử dụng, có một số phụ thuộc Python tùy chọn khác, có thể được cài đặt sau nếu cần:

  • Báo cáo, xem http://www.reportlab.com/opensource/ (tùy chọn) Gói này chỉ được sử dụng trong Bio.Graphics, vì vậy nếu bạn không cần chức năng này, bạn sẽ không cần cài đặt gói này.
  • matplotlib, xem http://matplotlib.org/ (tùy chọn) Bio.Phylo sử dụng gói này để vẽ các cây phát sinh.
  • NetworkX, xem https://networkx.github.io/ (tùy chọn) và pygraphviz hoặc pydot, xem https://pygraphviz.github.io/ và http://code.google.com/pydot/ (tùy chọn) Các gói này được sử dụng cho một số hàm thích hợp nhất định trong Bio.Phylo.
  • Rdflib, xem https://github.com/rdflib/rdflib (tùy chọn) Gói này được sử dụng trong trình phân tích cú pháp CDAO theo Bio.Phylo.
  • psycopg2, xem http://initd.org/psycopg/ (tùy chọn) hoặc pygresql (pgdb), xem http://www.pygresql.org/ (tùy chọn) Các gói này được sử dụng bởi
  • Trình kết nối MySQL/Python, xem http://dev.mysql.com/doads/connector/python/ Gói này được
    pip install biopython
    
    2 sử dụng để truy cập cơ sở dữ liệu MySQL và cũng được hỗ trợ trên PYPY.
  • mysqlclient, xem https://github.com/pymysql/mysqlclient-python (tùy chọn) Đây là một ngã ba của MySQLDB cũ và được
    pip install biopython
    
    2 sử dụng để truy cập cơ sở dữ liệu MySQL. Nó được hỗ trợ bởi Pypy.

Ngoài ra, có một số công cụ của bên thứ ba hữu ích mà bạn có thể muốn cài đặt như NCBI Blast độc lập, dập nổi hoặc clustalw.

Cài đặt từ nguồn

Chúng tôi khuyên bạn nên sử dụng các bánh xe nhị phân được biên dịch sẵn có sẵn trên PYPI bằng cách sử dụng:

pip install biopython

Tuy nhiên, nếu bạn cần tự biên dịch Biopython, những điều sau đây được yêu cầu tại thời điểm biên dịch:

  • Python bao gồm các tệp tiêu đề phát triển như

    pip install biopython
    
    5, trên Linux thường không được cài đặt theo mặc định (cố gắng tìm kiếm và cài đặt một gói có tên
    pip install biopython
    
    6 hoặc
    pip install biopython
    
    7 cũng như gói
    pip install biopython
    
    8).

  • Trình biên dịch C thích hợp cho phiên bản Python của bạn, ví dụ GCC trên Linux, MSVC trên Windows. Đối với Mac OS X hoặc như hiện tại được gắn nhãn hiệu, MacOS, sử dụng các công cụ dòng lệnh của Apple, có thể được cài đặt với lệnh đầu cuối:

    xcode-select --install
    

    Điều này sẽ cung cấp để cài đặt bộ phát triển Xcode của Apple - bạn có thể, nhưng nó không cần thiết và mất nhiều không gian đĩa.

Sau đó tải xuống và giải nén mã nguồn của chúng tôi hoặc tìm nạp nó bằng Git. Bây giờ thay đổi thư mục thành thư mục mã nguồn Biopython và chạy:

python setup.py build
python setup.py test
sudo python setup.py install

Thay thế

pip install biopython
8 bằng phiên bản cụ thể của bạn nếu được yêu cầu, ví dụ
xcode-select --install
0 hoặc
xcode-select --install
1.

Để loại trừ các thử nghiệm yêu cầu kết nối Internet (và có thể mất nhiều thời gian), hãy sử dụng tùy chọn

xcode-select --install
2:

python setup.py test --offline

Nếu bạn cần thực hiện cấu hình bổ sung, ví dụ: Thay đổi tiền tố thư mục cài đặt, vui lòng nhập

xcode-select --install
3.

Kiểm tra

Biopython bao gồm một bộ kiểm tra hồi quy để kiểm tra xem mọi thứ có chạy chính xác không. Để chạy các bài kiểm tra, hãy truy cập thư mục mã nguồn Biopython và loại:

python setup.py build
python setup.py test

Nếu bạn muốn bỏ qua các bài kiểm tra trực tuyến (được khuyến nghị khi thực hiện thử nghiệm lặp đi lặp lại), hãy sử dụng:

python setup.py test --offline

Không hoảng sợ nếu bạn thấy cảnh báo tin nhắn của các bài kiểm tra bị bỏ qua:

test_DocSQL ... skipping. Install MySQLdb if you want to use Bio.DocSQL.

Điều này rất có thể có nghĩa là một gói không được cài đặt. Bạn có thể bỏ qua điều này nếu nó xảy ra trong các thử nghiệm cho một mô -đun mà bạn không có kế hoạch sử dụng. Nếu bạn muốn sử dụng mô-đun đó, vui lòng cài đặt phụ thuộc cần thiết và chạy lại các bài kiểm tra.

Một số thử nghiệm có thể thất bại do các vấn đề về mạng, điều này thường giảm do cơ hội hoặc mất điện dịch vụ. Nếu sự cố không biến mất khi chạy lại các bài kiểm tra, bạn có thể sử dụng tùy chọn

xcode-select --install
2.

Có nhiều thông tin thử nghiệm trong cuốn sách hướng dẫn & nấu ăn Biopython.

Mã thử nghiệm

Biopython 1.61 đã đưa ra một cảnh báo mới,

xcode-select --install
5, được sử dụng để đánh dấu bất kỳ mã thử nghiệm nào có trong các bản phát hành Biopython ổn định khác. Mã mức 'beta' như vậy đã sẵn sàng để thử nghiệm rộng hơn, nhưng vẫn có khả năng thay đổi và chỉ nên được thử bởi những người chấp nhận sớm để đưa ra phản hồi thông qua danh sách gửi thư Biopython-Dev.

Chúng tôi hy vọng mã thử nghiệm như vậy sẽ đạt được trạng thái ổn định trong một hoặc hai bản phát hành, tại thời điểm đó, các chính sách thông thường của chúng tôi về việc cố gắng duy trì khả năng tương thích ngược sẽ được áp dụng.

Lỗi

Trong khi chúng tôi cố gắng vận chuyển một gói mạnh mẽ, các lỗi chắc chắn sẽ bật lên. Nếu bạn đang gặp vấn đề có thể gây ra bởi một lỗi trong Biopython, có thể nó đã được xác định. Cập nhật bản phát hành mới nhất nếu bạn chưa sử dụng nó và thử lại. Nếu sự cố vẫn còn, vui lòng tìm kiếm cơ sở dữ liệu lỗi của chúng tôi và danh sách gửi thư của chúng tôi để xem nó đã được báo cáo (và hy vọng đã được sửa), và nếu không xin vui lòng báo cáo lỗi. Chúng tôi không thể khắc phục sự cố mà chúng tôi không biết;)

Trình theo dõi vấn đề: https://github.com/biopython/biopython/issues

Nếu bạn nghi ngờ vấn đề nằm trong trình phân tích cú pháp, có khả năng định dạng dữ liệu đã thay đổi và phá vỡ mã phân tích cú pháp. . Bạn có thể nhận được trình phân tích cú pháp gần đây nhất bằng cách rút các tệp có liên quan (ví dụ: các tệp trong

xcode-select --install
6 hoặc
xcode-select --install
7) từ kho lưu trữ Git của chúng tôi. Tuy nhiên, hãy cẩn thận khi làm điều này, bởi vì mã trong GitHub không được thử nghiệm tốt như mã được phát hành và có thể chứa các phụ thuộc mới.

Trong bất kỳ báo cáo lỗi nào, vui lòng cho chúng tôi biết:

  1. Bạn đang sử dụng hệ điều hành và phần cứng nào (32 bit hoặc 64 bit)
  2. Phiên bản Python
  3. Phiên bản Biopython (hoặc Git cam kết/ngày)
  4. TraceBack xảy ra (thông báo lỗi đầy đủ)

Và cũng lý tưởng:

  1. Mã ví dụ bị phá vỡ
  2. Một tệp dữ liệu gây ra vấn đề

Đóng góp, báo cáo lỗi

Biopython được điều hành bởi các tình nguyện viên từ khắp nơi trên thế giới, với nhiều loại hình. Chúng tôi luôn tìm kiếm những người quan tâm đến việc giúp phát triển mã, quản lý trang web, viết tài liệu, quản trị kỹ thuật và bất cứ điều gì khác xuất hiện.

Nếu bạn muốn đóng góp, vui lòng đọc Đóng góp trước đây, hãy truy cập trang web của chúng tôi http://biopython.org và tham gia danh sách gửi thư của chúng tôi: http://biopython.org/wiki/mailing_lists

Cấu trúc phân phối

  • xcode-select --install
    
    8 - Tệp này.
  • xcode-select --install
    
    9 - Phát hành ghi chú và tin tức.
  • python setup.py build
    python setup.py test
    sudo python setup.py install
    
    0 - Những gì bạn có thể làm với mã.
  • python setup.py build
    python setup.py test
    sudo python setup.py install
    
    1 - một danh sách (không đầy đủ) của những người đã giúp Biopython bằng cách này hay cách khác.
  • python setup.py build
    python setup.py test
    sudo python setup.py install
    
    2 - Tổng quan về cách đóng góp cho Biopython.
  • python setup.py build
    python setup.py test
    sudo python setup.py install
    
    3 - Chứa thông tin về các mô -đun trong Biopython đã bị xóa hoặc không còn được khuyến nghị sử dụng và cách cập nhật mã sử dụng các mô -đun đó.
  • python setup.py build
    python setup.py test
    sudo python setup.py install
    
    4 - Định cấu hình các tệp nào sẽ bao gồm trong các bản phát hành.
  • python setup.py build
    python setup.py test
    sudo python setup.py install
    
    5 - Tệp cài đặt.
  • python setup.py build
    python setup.py test
    sudo python setup.py install
    
    6 - Mã cơ sở mã chính.
  • python setup.py build
    python setup.py test
    sudo python setup.py install
    
    7 - Mã để sử dụng Biopython với cơ sở dữ liệu BIOSQL.
  • python setup.py build
    python setup.py test
    sudo python setup.py install
    
    8 - Tài liệu.
  • python setup.py build
    python setup.py test
    sudo python setup.py install
    
    9 - Các kịch bản độc lập, có thể hữu ích, có thể hữu ích.
  • python setup.py test --offline
    
    0 - Mã kiểm tra hồi quy bao gồm các tệp dữ liệu mẫu.