โครงการ Biopython เป็นสมาคมระหว่างประเทศของนักพัฒนาเครื่องมือ Python ที่มีให้ใช้งานฟรีสำหรับชีววิทยาโมเลกุลเชิงคำนวณ
ไฟล์ README นี้มีไว้สำหรับผู้ที่สนใจทำงานกับซอร์สโค้ด Biopython เป็นหลัก ไม่ว่าจะเป็นการเผยแพร่จากเว็บไซต์ http://biopython.org หรือจากพื้นที่เก็บข้อมูลของเราบน GitHub https://github.com/biopython/biopython
เอกสารที่เน้นผู้ใช้เป็นศูนย์กลางของเรา The Biopython Tutorial and Cookbook และเอกสารประกอบ API สร้างขึ้นจากพื้นที่เก็บข้อมูลของเราโดยใช้ Sphinx
ไฟล์ NEWS สรุปการเปลี่ยนแปลงใน Biopython แต่ละรุ่น ควบคู่ไปกับไฟล์ DEPRECATED ซึ่งบันทึกการแตกของ API
แพ็คเกจ Biopython เป็นซอฟต์แวร์โอเพ่นซอร์สที่เผยแพร่ภายใต้เงื่อนไขที่เอื้อเฟื้อ โปรดดูไฟล์ใบอนุญาตสำหรับรายละเอียดเพิ่มเติม
หากคุณใช้ Biopython ในงานตีพิมพ์ทางวิทยาศาสตร์ เราขอให้คุณอ้างอิงเอกสารการสมัครของเรา (ด้านล่าง) หรือสิ่งพิมพ์เฉพาะโมดูลฉบับใดฉบับหนึ่ง (แสดงอยู่ในเว็บไซต์ของเรา):
ไก่ PJA และคณะ Biopython: เครื่องมือ Python ที่มีให้ใช้งานฟรีสำหรับอณูชีววิทยาเชิงคำนวณและชีวสารสนเทศศาสตร์ ชีวสารสนเทศศาสตร์ 2552 1 มิ.ย.; 25(11) 1422-3 https://doi.org/10.1093/bioinformatics/btp163 pmid:19304878
Python มีระบบจัดการแพ็คเกจ "pip" ซึ่งจะช่วยให้คุณสามารถติดตั้ง Biopython (และ NumPy ที่ขึ้นต่อกันได้หากจำเป็น) อัปเกรดหรือถอนการติดตั้งด้วยคำสั่งเทอร์มินัลเพียงคำสั่งเดียว:
pip ติดตั้ง biopython pip install --อัพเกรด biopython pip ถอนการติดตั้ง biopython
ตั้งแต่ Biopython 1.70 เราได้จัดเตรียมแพ็คเกจไบนารี่วีลที่คอมไพล์ไว้ล่วงหน้าบน PyPI สำหรับ Linux, macOS และ Windows ซึ่งหมายความว่าการติดตั้ง pip ควรรวดเร็วและไม่ต้องใช้คอมไพเลอร์
ในฐานะนักพัฒนาหรือผู้ร่วมให้ข้อมูล คุณอาจต้องการดาวน์โหลด สร้าง และติดตั้ง Biopython ด้วยตนเอง นี่คือคำอธิบายด้านล่าง
ขณะนี้เราแนะนำให้ใช้ Python 3.11 จาก http://www.python.org
ปัจจุบัน Biopython ได้รับการสนับสนุนและทดสอบในการใช้งาน Python ต่อไปนี้:
Biopython ต้องการ NumPy (ดู http://www.numpy.org) ซึ่งจะถูกติดตั้งโดยอัตโนมัติหากคุณติดตั้ง Biopython ด้วย pip (ดูด้านล่างสำหรับการคอมไพล์ Biopython ด้วยตัวเอง)
ขึ้นอยู่กับส่วนใดของ Biopython ที่คุณวางแผนจะใช้ มีการพึ่งพา Python ทางเลือกอื่นๆ อีกหลายรายการ ซึ่งสามารถติดตั้งได้ในภายหลังหากจำเป็น:
Bio.Graphics
เท่านั้น ดังนั้นหากคุณไม่ต้องการฟังก์ชันนี้ คุณก็ไม่จำเป็นต้องติดตั้งแพ็คเกจนี้Bio.Phylo
ใช้แพ็คเกจนี้เพื่อพล็อตต้นไม้สายวิวัฒนาการBio.Phylo
Bio.Phylo
BioSQL
ใช้แพ็คเกจเหล่านี้เพื่อเข้าถึงฐานข้อมูล PostgreSQLBioSQL
ใช้งานแพ็คเกจนี้เพื่อเข้าถึงฐานข้อมูล MySQL และรองรับ PyPy ด้วยเช่นกันBioSQL
ใช้เพื่อเข้าถึงฐานข้อมูล MySQL รองรับโดย PyPyนอกจากนี้ยังมีเครื่องมือของบุคคลที่สามที่มีประโยชน์อีกมากมายที่คุณอาจต้องการติดตั้ง เช่น NCBI BLAST, EMBOSS หรือ ClustalW แบบสแตนด์อโลน
เราขอแนะนำให้ใช้ล้อไบนารีที่คอมไพล์ไว้ล่วงหน้าบน PyPI โดยใช้:
pip ติดตั้ง biopython
อย่างไรก็ตาม หากคุณต้องการคอมไพล์ Biopython ด้วยตัวเอง ในเวลาคอมไพล์จำเป็นต้องมีสิ่งต่อไปนี้:
Python รวมถึงไฟล์ส่วนหัวการพัฒนาเช่น python.h
ซึ่งบน Linux มักจะไม่ได้ติดตั้งตามค่าเริ่มต้น (พยายามค้นหาและติดตั้งแพ็คเกจชื่อ python-dev
หรือ python-devel
รวมถึงแพ็คเกจ python
)
คอมไพเลอร์ C ที่เหมาะสมสำหรับเวอร์ชัน Python ของคุณ เช่น GCC บน Linux, MSVC บน Windows สำหรับ Mac OS X หรือที่ปัจจุบันใช้ชื่อแบรนด์ว่า macOS ให้ใช้เครื่องมือบรรทัดคำสั่งของ Apple ซึ่งสามารถติดตั้งได้ด้วยคำสั่งเทอร์มินัล:
xcode-select --install
สิ่งนี้จะเสนอให้ติดตั้งชุดพัฒนา XCode ของ Apple คุณสามารถทำได้ แต่ไม่จำเป็นและใช้พื้นที่ดิสก์มาก
จากนั้นดาวน์โหลดและขยายซอร์สโค้ดของเรา หรือดึงข้อมูลโดยใช้ git ตอนนี้เปลี่ยนไดเร็กทอรีเป็นโฟลเดอร์ซอร์สโค้ด Biopython แล้วรัน:
pip ติดตั้ง -e การทดสอบหลาม setup.py ติดตั้ง sudo python setup.py
แทนที่ python
ด้วยเวอร์ชันเฉพาะของคุณหากจำเป็น เช่น python3
หรือ pypy3
หากต้องการยกเว้นการทดสอบที่ต้องใช้การเชื่อมต่ออินเทอร์เน็ต (และอาจใช้เวลานาน) ให้ใช้ตัวเลือก --offline
:
การทดสอบ python setup.py -- ออฟไลน์
หากคุณต้องการกำหนดค่าเพิ่มเติม เช่น เปลี่ยนคำนำหน้าไดเร็กทอรีการติดตั้ง โปรดพิมพ์ python setup.py
Biopython มีชุดการทดสอบการถดถอยเพื่อตรวจสอบว่าทุกอย่างทำงานอย่างถูกต้องหรือไม่ หากต้องการรันการทดสอบ ให้ไปที่ไดเร็กทอรีซอร์สโค้ด biopython และพิมพ์:
pip ติดตั้ง -e การทดสอบหลาม setup.py
หากคุณต้องการข้ามการทดสอบออนไลน์ (ซึ่งแนะนำเมื่อทำการทดสอบซ้ำ) ให้ใช้:
การทดสอบ python setup.py -- ออฟไลน์
อย่าตกใจหากคุณเห็นข้อความคำเตือนการข้ามการทดสอบ:
test_DocSQL ... กำลังข้าม ติดตั้ง MySQLdb หากคุณต้องการใช้ Bio.DocSQL
เป็นไปได้มากว่าไม่ได้ติดตั้งแพ็คเกจ คุณสามารถเพิกเฉยต่อสิ่งนี้ได้ หากเกิดขึ้นในการทดสอบโมดูลที่คุณไม่ได้วางแผนจะใช้ หากคุณต้องการใช้โมดูลนั้น โปรดติดตั้งการขึ้นต่อกันที่จำเป็นและทำการทดสอบอีกครั้ง
การทดสอบบางอย่างอาจล้มเหลวเนื่องจากปัญหาเครือข่าย ซึ่งมักเกิดจากโอกาสหรือบริการขัดข้อง หากปัญหาไม่หายไปเมื่อทำการทดสอบซ้ำ คุณสามารถใช้ตัวเลือก --offline
มีข้อมูลการทดสอบเพิ่มเติมใน Biopython Tutorial & Cookbook
Biopython 1.61 นำเสนอคำเตือนใหม่ Bio.BiopythonExperimentalWarning
ซึ่งใช้เพื่อทำเครื่องหมายโค้ดการทดลองใดๆ ที่รวมอยู่ในการเผยแพร่ Biopython ที่เสถียรอย่างอื่น โค้ดระดับ 'เบต้า' ดังกล่าวพร้อมสำหรับการทดสอบในวงกว้าง แต่ก็ยังมีแนวโน้มที่จะเปลี่ยนแปลง และควรลองใช้โดยผู้ใช้ในช่วงแรกเท่านั้น เพื่อให้ข้อเสนอแนะผ่านทางรายชื่อผู้รับจดหมาย biopython-dev
เราคาดหวังว่าโค้ดทดลองดังกล่าวจะมีสถานะเสถียรภายในหนึ่งหรือสองรุ่น ซึ่ง ณ จุดนี้นโยบายปกติของเราเกี่ยวกับการพยายามรักษาความเข้ากันได้แบบย้อนหลังจะถูกนำมาใช้
แม้ว่าเราพยายามจัดส่งพัสดุที่แข็งแกร่ง แต่ก็มีจุดบกพร่องปรากฏขึ้นอย่างหลีกเลี่ยงไม่ได้ หากคุณกำลังประสบปัญหาที่อาจเกิดจากจุดบกพร่องใน Biopython อาจเป็นไปได้ว่าปัญหาดังกล่าวได้รับการระบุแล้ว อัปเดตเป็นรุ่นล่าสุด หากคุณยังไม่ได้ใช้งาน และลองอีกครั้ง หากปัญหายังคงอยู่ โปรดค้นหาฐานข้อมูลจุดบกพร่องและรายชื่ออีเมลของเราเพื่อดูว่ามีการรายงานแล้วหรือไม่ (และหวังว่าจะได้รับการแก้ไขแล้ว) และหากไม่เป็นเช่นนั้น โปรดรายงานจุดบกพร่อง เราไม่สามารถแก้ไขปัญหาที่เราไม่รู้ได้ ;)
ติดตามปัญหา: https://github.com/biopython/biopython/issues
หากคุณสงสัยว่าปัญหาอยู่ใน parser อาจเป็นไปได้ว่ารูปแบบข้อมูลมีการเปลี่ยนแปลงและทำให้โค้ดการแยกวิเคราะห์เสียหาย (รูปแบบข้อความ BLAST และ GenBank ดูเหมือนจะเปราะบางเป็นพิเศษ) ดังนั้น บางครั้งโค้ดการแยกวิเคราะห์ใน Biopython จึงได้รับการอัปเดตเร็วกว่าที่เราจะสร้าง Biopython ได้ คุณสามารถรับ parser ล่าสุดได้โดยการดึงไฟล์ที่เกี่ยวข้อง (เช่น ไฟล์ใน Bio.SeqIO
หรือ Bio.Blast
) จากที่เก็บ git ของเรา อย่างไรก็ตาม โปรดใช้ความระมัดระวังเมื่อทำเช่นนี้ เนื่องจากโค้ดใน GitHub ไม่ได้รับการทดสอบอย่างดีเท่ากับโค้ดที่เผยแพร่ และอาจมีการอ้างอิงใหม่
ในรายงานข้อผิดพลาดใดๆ โปรดแจ้งให้เราทราบ:
และในอุดมคติแล้ว:
Biopython ดำเนินการโดยอาสาสมัครจากทั่วทุกมุมโลกซึ่งมีภูมิหลังหลายประเภท เรามองหาผู้ที่สนใจช่วยเหลือในการพัฒนาโค้ด การจัดการเว็บไซต์ การเขียนเอกสาร การบริหารด้านเทคนิค และอื่นๆ อยู่เสมอ
หากคุณต้องการมีส่วนร่วม โปรดอ่าน CONTRIBUTING.rst ที่นี่ เยี่ยมชมเว็บไซต์ของเรา http://biopython.org และเข้าร่วมรายชื่ออีเมลของเรา: http://biopython.org/wiki/Mailing_lists
README.rst
-- ไฟล์นี้NEWS.rst
-- บันทึกประจำรุ่นและข่าวสารLICENSE.rst
-- คุณสามารถทำอะไรกับโค้ดได้CONTRIB.rst
-- รายชื่อ (ไม่สมบูรณ์) ของผู้ที่ช่วยเหลือ Biopython ไม่ทางใดก็ทางหนึ่งCONTRIBUTING.rst
-- ภาพรวมเกี่ยวกับวิธีการมีส่วนร่วมกับ BiopythonDEPRECATED.rst
-- ประกอบด้วยข้อมูลเกี่ยวกับโมดูลใน Biopython ที่ถูกลบออกหรือไม่แนะนำให้ใช้อีกต่อไป และวิธีการอัปเดตโค้ดที่ใช้โมดูลเหล่านั้นMANIFEST.in
-- กำหนดค่าไฟล์ที่จะรวมไว้ในรุ่นต่างๆsetup.py
-- ไฟล์การติดตั้งBio/
-- รหัสฐานรหัสหลักBioSQL/
-- โค้ดสำหรับใช้ Biopython กับฐานข้อมูล BioSQLDoc/
-- เอกสาร.Scripts/
-- สคริปต์แบบสแตนด์อโลนเบ็ดเตล็ดที่อาจมีประโยชน์Tests/
-- โค้ดการทดสอบการถดถอยรวมถึงไฟล์ข้อมูลตัวอย่าง