├── requirements.txt ├── docs ├── at-logo.png ├── _static │ ├── img │ │ ├── joe.jpg │ │ ├── henry.jpg │ │ ├── pieces.png │ │ ├── hostedby.png │ │ ├── nogueira.jpg │ │ ├── webseeds.png │ │ └── pieces-corrupt.png │ └── js │ │ └── custom.js ├── index.rst ├── downloading.md ├── faq.md ├── searching.md ├── mirroring.md ├── uploading.md ├── bittorrent.md ├── api.md ├── about.md ├── Makefile ├── make.bat ├── getting-started.md └── conf.py ├── README.md └── .readthedocs.yml /requirements.txt: -------------------------------------------------------------------------------- 1 | sphinx 2 | recommonmark 3 | sphinx_rtd_theme 4 | sphinx_markdown_tables 5 | -------------------------------------------------------------------------------- /docs/at-logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/academictorrents/academictorrents-docs/HEAD/docs/at-logo.png -------------------------------------------------------------------------------- /docs/_static/img/joe.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/academictorrents/academictorrents-docs/HEAD/docs/_static/img/joe.jpg -------------------------------------------------------------------------------- /docs/_static/img/henry.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/academictorrents/academictorrents-docs/HEAD/docs/_static/img/henry.jpg -------------------------------------------------------------------------------- /docs/_static/img/pieces.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/academictorrents/academictorrents-docs/HEAD/docs/_static/img/pieces.png -------------------------------------------------------------------------------- /docs/_static/img/hostedby.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/academictorrents/academictorrents-docs/HEAD/docs/_static/img/hostedby.png -------------------------------------------------------------------------------- /docs/_static/img/nogueira.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/academictorrents/academictorrents-docs/HEAD/docs/_static/img/nogueira.jpg -------------------------------------------------------------------------------- /docs/_static/img/webseeds.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/academictorrents/academictorrents-docs/HEAD/docs/_static/img/webseeds.png -------------------------------------------------------------------------------- /docs/_static/img/pieces-corrupt.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/academictorrents/academictorrents-docs/HEAD/docs/_static/img/pieces-corrupt.png -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | View documentation here: [https://academictorrents.com/docs/](https://academictorrents.com/docs/) 2 | 3 | 4 | 5 | Old url: [https://academictorrents.readthedocs.io/en/latest/](https://academictorrents.readthedocs.io/en/latest/) 6 | -------------------------------------------------------------------------------- /docs/_static/js/custom.js: -------------------------------------------------------------------------------- 1 | 2 | var ascript = document.createElement('script'); 3 | ascript.setAttribute('src','https://media.ethicalads.io/media/client/ethicalads.min.js'); 4 | document.head.appendChild(ascript); 5 | 6 | $.ajax("/a_router.php?color=dark", { 7 | success: function( data ) { 8 | $(".wy-side-scroll").append(data); 9 | } 10 | }); 11 | -------------------------------------------------------------------------------- /.readthedocs.yml: -------------------------------------------------------------------------------- 1 | # .readthedocs.yml 2 | # Read the Docs configuration file 3 | # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details 4 | 5 | # Required 6 | version: 2 7 | 8 | # Build documentation in the docs/ directory with Sphinx 9 | sphinx: 10 | configuration: docs/conf.py 11 | 12 | # Build documentation with MkDocs 13 | #mkdocs: 14 | # configuration: mkdocs.yml 15 | 16 | # Optionally build your docs in additional formats such as PDF 17 | #formats: 18 | # - pdf 19 | 20 | -------------------------------------------------------------------------------- /docs/index.rst: -------------------------------------------------------------------------------- 1 | .. Read the Docs Template documentation master file, created by 2 | sphinx-quickstart on Tue Aug 26 14:19:49 2014. 3 | You can adapt this file completely to your liking, but it should at least 4 | contain the root `toctree` directive. 5 | 6 | Welcome to Academic Torrents documentation! 7 | ================================================== 8 | 9 | Contents: 10 | 11 | .. toctree:: 12 | :maxdepth: 2 13 | :glob: 14 | 15 | about* 16 | getting-started* 17 | faq* 18 | 19 | * 20 | 21 | -------------------------------------------------------------------------------- /docs/downloading.md: -------------------------------------------------------------------------------- 1 | # Downloading 2 | 3 | A tutorial video about downloading 4 | 5 | 6 | 7 | 8 | We recommend using the Transmission torrent client, which supports all major operating systems. You can download it from [https://www.transmissionbt.com/](https://www.transmissionbt.com/). 9 | 10 | 11 | ## From the command line 12 | 13 | 14 | We recommend [aria2c](https://aria2.github.io/). Specify a torrent URL or the magnet link to download. Here is an example usage: 15 | 16 | ```bash 17 | aria2c --seed-time=0 --max-overall-download-limit=10M --file-allocation=none https://academictorrents.com/download/c5af268ec55cf2d3b439e7311ad43101ba8322eb.torrent 18 | ``` 19 | 20 | Useful switches: 21 | 22 | - `--seed-ratio=0` Stop after downloading 23 | - `--file-allocation=none` Start downloading right away instead of allocating the file on disk 24 | - `--max-overall-download-limit=10M` Limit the download speed to prevent high speeds from breaking things 25 | 26 | 27 | 28 | As an alternative we also provide a pure python client at-python which can be installed as follows: 29 | 30 | ```bash 31 | $ pip install academictorrents 32 | $ at-get c5af268ec55cf2d3b439e7311ad43101ba8322eb 33 | ``` 34 | 35 | 36 | ## Python API 37 | 38 | This repository is an implementation of the BitTorrent protocol written in Python and downloadable as a pip module. 39 | 40 | https://github.com/academictorrents/at-python 41 | 42 | You can download datasets from AcademicTorrents.com in two lines of code: 43 | 44 | ```python 45 | import academictorrents as at 46 | path_of_dataset = at.get("323a0048d87ca79b68f12a6350a57776b6a3b7fb") # Download mnist dataset 47 | ``` 48 | -------------------------------------------------------------------------------- /docs/faq.md: -------------------------------------------------------------------------------- 1 | # Frequently Asked Questions 2 | 3 | ## Cannot connect to tracker 4 | 5 | If your BitTorrent client cannot connect to the tracker first diagnose why using the follow command: 6 | 7 | ``` 8 | $curl https://academictorrents.com/announce.php 9 | ``` 10 | 11 | You should see the failure message `"d14:failure reason24:Invalid info_hash (0 - )e"` if you can connect. If it doesn't work then run `curl -vvv` to get details on the error. 12 | 13 | ## People cannot connect to your server 14 | 15 | To ensure optimal mirroring/seeding performance, it is important that the port your BitTorrent client is listening on is accessible from the internet. This may require allowing a port in a firewall or setting up port forwarding in a router. 16 | 17 | You can check if the tracker can connect to your client's port by looking at the `Connect` column on the Technical tab of the Details page. If it says `Yes`, the tracker can successfully connect to the port. 18 | 19 | You can verify this yourself from a computer outside of your network with the following command: 20 | 21 | ``` 22 | nc -v {serveraddress} {port} 23 | ``` 24 | 25 | An example of a successful connection will look like: 26 | 27 | ``` 28 | $ nc -v host2.academictorrents.com 25000 29 | Connection to host2.academictorrents.com port 25000 [tcp/icl-twobase1] succeeded! 30 | ``` 31 | 32 | An example of a unsuccessful connection will look like: 33 | 34 | ``` 35 | $ nc -v host2.academictorrents.com 25001 36 | nc: connectx to host2.academictorrents.com port 25001 (tcp) failed: Operation timed out 37 | ``` 38 | 39 | 40 | ## Transmission HTTP Response code 0 (No Response) 41 | 42 | This error seems to be associated with an erroneous default IPv6 configuration in Transmission causing the client to make requests incorrectly. The steps to fix this problem are as follows: 43 | 44 | Shut down transmission-daemon (service transmission-daemon stop) 45 | Edit the settings.json file (default location: /etc/transmission-daemon/settings.json) 46 | 47 | Change "bind-address-ipv6": "fe80::", 48 | to "bind-address-ipv6": "::", 49 | 50 | Restart transmission (service transmission-daemon start) 51 | 52 | 53 | 54 | 55 | 56 | -------------------------------------------------------------------------------- /docs/searching.md: -------------------------------------------------------------------------------- 1 | # Searching 2 | 3 | ## Overview 4 | 5 | The website provides the ability for humans to search the database. 6 | However, for robots we provide a few XML URLs to help programatically navigate the database. 7 | 8 | For a standard RSS feed of recent entries there is: 9 | 10 | [https://academictorrents.com/rss.xml](https://academictorrents.com/rss.xml) 11 | 12 | 13 | For enable users programmatically search the entire database we provide an XML file in RSS format 14 | containing all public entries. The expectation here is that you will download this file locally 15 | and then search offline. It contains the torrent title, description, the URL of the details page, 16 | and the infohash which can be used to construct a magnet link for the torrent. 17 | 18 | [https://academictorrents.com/database.xml](https://academictorrents.com/database.xml) 19 | 20 | Some example output: 21 | 22 | 23 | ```xml 24 | 25 | 26 | Academic Torrents 27 | All Torrents 28 | http://academictorrents.com/ 29 | 30 | MLDS-DS3-10000-v1.0 31 | Dataset 32 | b2bbaccd349e8e2954a438ced6fc01adae4ea1f1 33 | http://academictorrents.com/details/b2bbaccd349e8e2954a438ced6fc01adae4ea1f1 34 | http://academictorrents.com/details/b2bbaccd349e8e2954a438ced6fc01adae4ea1f1 35 | Machine Learning Dataset, DS3-10000 v1.0: A dataset for parameter-space analysis of neural networks. See https://www.mlcathome.org/ for more information 36 | 1354135939103 37 | 38 | 39 | MLDS-DS3-5000-v1.0 40 | Dataset 41 | c143f1b108fe5ab748d5a6f1ff7b2a6271e4219d 42 | http://academictorrents.com/details/c143f1b108fe5ab748d5a6f1ff7b2a6271e4219d 43 | http://academictorrents.com/details/c143f1b108fe5ab748d5a6f1ff7b2a6271e4219d 44 | Machine Learning Dataset, DS3-5000 v1.0: A dataset for parameter-space analysis of neural networks. See https://www.mlcathome.org/ for more information 45 | 677223180049 46 | 47 | ... 48 | 49 | 50 | 51 | ``` 52 | 53 | 54 | -------------------------------------------------------------------------------- /docs/mirroring.md: -------------------------------------------------------------------------------- 1 | # Mirroring 2 | 3 | ## Overview 4 | 5 | One benefit of BitTorrent is the ability for the data to be dynamically mirrored. You can become part of the Academic Torrents hosting infrastructure by "seeding" the data that you have downloaded. Your BitTorrent client will automatically register with our tracker (sending your IP address and port to connect to) when you open the BitTorrent file in it and the data you have downloaded will be available to be sent to others. 6 | 7 | We recommend using Transmission Daemon (Linux package `transmission-daemon`) because it runs as a background service and will automatically start with the system and is very stable. 8 | 9 | 10 | ## Transmission Daemon 11 | 12 | To set up Transmission Daemon on Debian/Ubuntu install the package: 13 | 14 | ``` 15 | sudo apt install transmission-daemon 16 | ``` 17 | 18 | Once it is installed a web server to control the client is available at `http://localhost:9091/`. Be sure to set a username and password in the configuration file. 19 | 20 | 21 | In `/etc/transmission-daemon/settings.json` set: 22 | ``` 23 | "rpc-authentication-required": true, 24 | "rpc-password": "something", 25 | "rpc-username": "something", 26 | ``` 27 | 28 | 29 | Note you need to stop transmission before editing the settings file or your changes will be erased. 30 | ``` 31 | service transmission-daemon stop 32 | ## edit /etc/transmission-daemon/settings.json 33 | service transmission-daemon start 34 | ``` 35 | 36 | 37 | ## "Hosted by" attribution 38 | 39 | 40 | 41 | When hosting a torrent you can have this be associated with your account in order to show your name and image. On the details page of each torrent a box shows users which are currently hosting data. 42 | 43 | In order for our system to associate your account with a torrent is a passkey that is embedded in the torrent file. This is inserted when you download a torrent while logged in. Some BitTorrent clients let you specify cookies used when requesting .torrent files. You can use your API key as the cookie to associate the torrent with your account. 44 | 45 | ## Collections 46 | 47 | We would like to avoid the blind mirroring of all data. We provide RSS feeds for subsets of all the torrents grouped into collections. 48 | 49 | Per collection RSS feeds allow you to mirror only collections you care about. Each collection has it's own unique RSS feed. You can add the RSS feeds found on this page: [http://academictorrents.com/collections.php](http://academictorrents.com/collections.php) You can mirror these RSS feeds automatically with a BitTorrent client such as ruTorrent, uTorrent, or qBitTorrent. 50 | 51 | 52 | ## Smartnodes 53 | 54 | We are slowly making progress on tools which automatically download and manage torrents. The current development repo is here: [https://github.com/academictorrents/smartnode-transmission](https://github.com/academictorrents/smartnode-transmission ) 55 | 56 | The goals of this project are as follows: 57 | 58 | - Smart BitTorrent client (Not just syncing an RSS feed) 59 | - Mirrors based on resources donated 60 | - Limit by space 61 | - Limit by RSS feed 62 | - Limit by bandwidth 63 | - Dynamically select in-need data 64 | - Low peers 65 | - Not geographically distributed 66 | - Slow downloads 67 | - Completely client side 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | -------------------------------------------------------------------------------- /docs/uploading.md: -------------------------------------------------------------------------------- 1 | # Uploading 2 | 3 | ## Overview 4 | 5 | There are multiple ways to share your data on our site. If you're unsure about the process, please reach out to us for assistance. You can use the upload form available at [https://academictorrents.com/upload.php](https://academictorrents.com/upload.php). 6 | 7 | It's important to note that we don't directly host your data. However, we manage a network of donated servers. When you upload a torrent file to our site, hosting nodes (seeds) register with the tracker to provide download locations for the data. Alternatively, you can use a Backup URL instead of hosting the file using BitTorrent. This allows you to take advantage of our server platform, where the data will be mirrored. 8 | 9 | ## Tutorials 10 | 11 | Academic Torrents - How to upload for researchers 12 | 13 | 14 |

15 | 16 | ## Piece sizes 17 | 18 | The piece size of a torrent is the size of the smallest chunk of the file that is sent between torrent clients. Valid sizes are powers of 2. If the total number of pieces is large then it will a lot of small transactions will have to happen when downloading and may require a lot of CPU because each piece needs to have its hash computed in order to verify it is correct. If the piece size is too large then the transmission may fail in the middle and require the entire piece to be sent again. 19 | 20 | We recommend relatively large piece sizes (`8192` or `16384` KiB) because academic connections are typically good enough to not produce errors at this size and a very large file with a small piece size could yield so many pieces that it is a computational burden to download it. 21 | 22 | 23 | ## Backup URLs 24 | 25 | ![](_static/img/webseeds.png) 26 | 27 | When a user downloads a torrent, in the event that BitTorrent is blocked or if there are no seed nodes, a list of Backup URLs (also called WedSeeds) can be maintained dynamically. These URLs can be updated on the website and then are injected into the torrent file when it is downloaded. These will bypass firewalls because it looks like regular web browsing. The experience is the same as downloading the torrent normally when using a BitTorrent client which supports (such as Transmission). 28 | 29 | A "Backup URL" which is an HTTP URL linking to the data file (or if it is a directory then the URL minus the folder name). 30 | 31 | In the case of a folder it is important to use the correct path. If the files are in a folder named `sourcedata` and the files are on a server under this path `http://server/folder/sourcedata/` then the Backup URL would be `http://server/folder/` 32 | 33 | Here is an example torrent with a backup url: http://academictorrents.com/details/cf445f6073540af0803ee345f46294f088e7bba5 34 | 35 | The backup url is "https://files.inria.fr/" because the folder that contains the files is aerialimagelabeling and they can be accessed like this: https://files.inria.fr/aerialimagelabeling/aerialimagelabeling.7z.001 36 | 37 | Note: this is only the case for torrents which are created from folders. If the torrent is just a single file then you specify the direct path. 38 | 39 | ### RANGE queries 40 | 41 | BitTorrent clients will use HTTP RANGE queries to select the pieces they want to download. If this is not available then the client will try to download the entire file at once which can fail if the file is too large or the connection is unstable. 42 | 43 | Most webservers will support this (such as Apache and NGNIX) but less featured webservers such as the python http.server do not have this feature. 44 | 45 | ### Hosting providers that work as Backup URLs 46 | 47 | Almost all paid providers work work perfectly as Backup URLs while almost all free hosting provders (Google Drive, Dropbox) do not work as Backup URLs. Here is a list of free providers which will provide HTTP URLs that can be used as Backup URLs: 48 | 49 | - [https://archive.org](https://archive.org) 50 | - [https://zenodo.org/](https://zenodo.org/) (only works for single files torrents) 51 | 52 | -------------------------------------------------------------------------------- /docs/bittorrent.md: -------------------------------------------------------------------------------- 1 | # BitTorrent 2 | 3 | BitTorrent is a peer-to-peer (P2P) file-sharing protocol that enables efficient distribution of large files. It achieves this by breaking files into smaller pieces and distributing them among a network of users, known as "peers." Each peer shares these pieces with others, allowing for simultaneous downloading from multiple sources. 4 | 5 | The protocol relies on a central tracker, which keeps track of the location of file pieces and the peers sharing them. When a user wants to download a file, they connect to a tracker (such as Academic Torrents) to obtain a list of peers with the file. The user then connects to these peers and starts downloading the file pieces. 6 | 7 | One of BitTorrent's key features is its "swarm-based" nature. As more users download a file, the number of available sources for other users to download from increases. This ensures fast and reliable downloads, even with a growing number of users. 8 | 9 | BitTorrent is decentralized, meaning there is no central server or authority controlling file distribution. This eliminates single points of failure that could disrupt the network. 10 | 11 | Numerous open-source BitTorrent clients are available. These clients handle connecting to trackers, downloading file pieces, and managing data upload and download. This diversity and accessibility of clients prevent a single entity from gaining monopolistic control and imposing charges or restrictions on usage. 12 | 13 | ## Pieces 14 | 15 | In BitTorrent, files are broken down into small pieces. Historcially the sizes are between `64` and `256` KiB in size but for Academic Torrents they can go up to `8192` or `16384` KiB to better handle large files. Each of these pieces is then assigned a (hopefully) unique cryptographic SHA1 hash, which is used to ensure the integrity of the data by the clients. This means that when a user downloads a piece of a file, they can compare the hash of the piece they received to the one that was originally computed by the file creator, to ensure that the data has not been tampered with or corrupted. 16 | 17 | ![](_static/img/pieces.png) 18 | 19 | When a user first creates a new file to share using BitTorrent, they first compute the hash of each piece of the file and create a "metadata" file, also known as a ".torrent" file. This file contains the list of hashes for all the pieces of the file, as well as information about the file itself, such as filenames, sizes, and the address of the tracker. 20 | 21 | The use of cryptographic hashes in BitTorrent helps to ensure the integrity of the data being shared on the network, and helps to prevent the spread of corrupted or tampered files. This is particularly important for large files, where a single corrupted piece can render the entire file unusable. When receiving a piece from a peer the hash of the piece is computed. If the hash matches what is contained in the metadata, the user knows that the piece is an authentic and uncorrupted version of the file. However, if the hash does not match, the user knows that the piece is corrupt and needs to be redownloaded. 22 | 23 | When a corrupt piece is detected, the BitTorrent client will typically mark the piece as "bad" and request a new copy from one of the other peers that the client is connected to. A piece may become corrupted due to a problem with the storage media, a network error, or even an intentional attack. Using hashing in this fashion allows the identification of a small corrupt piece in a large file so the entire file won't need to be restored. 24 | 25 | ![](_static/img/pieces-corrupt.png) 26 | 27 | 28 | ## Trackers 29 | 30 | In BitTorrent, a "tracker" is a server that keeps track of the location of all the pieces of a file and the peers that are currently sharing them. When a user wants to download a file, they connect to the tracker, which provides them with a list of peers that have the file. The user then connects to these peers and begins downloading the pieces of the file. The requesting user is added to the tracker and will be shared on subsequent requests. 31 | 32 | The tracker plays a crucial role in the BitTorrent network by coordinating the distribution of files among peers. It maintains a list of peers sharing a file and the percentage of the file they have. Peers connect with each other to determine which pieces they have. 33 | 34 | In recent years, some clients have adopted a technique known as "trackerless" or "DHT" (Distributed Hash Table). This technique eliminates the need for a central tracker and relies on a distributed system of nodes to keep track of peers and files, making the network more resilient. 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | -------------------------------------------------------------------------------- /docs/api.md: -------------------------------------------------------------------------------- 1 | # API 2 | 3 | ## Database Access 4 | 5 | To ensure efficient and effective database searches, we recommend downloading the entire database (available at the following URL) and conducting searches on the locally saved file. 6 | This file is regularly updated on a nightly basis, allowing us to optimize performance and scalability by avoiding local searches. 7 | 8 | 9 | Database: [https://academictorrents.com/database.xml](https://academictorrents.com/database.xml) 10 | 11 | 12 | ## Endpoint 13 | 14 | Our API is constantly improving based on feedback from users. Please contact us if you are planning to use the API so that we can make it fit your needs better. The basic api is shown below. 15 | 16 | Base API url: [https://academictorrents.com/apiv2/](https://academictorrents.com/apiv2/) 17 | 18 | ``` 19 | ===Entries=== 20 | GET /apiv2/entry/INFOHASH -- retrieve data about an INFOHASH 21 | POST /apiv2/entry -- upload an entry 22 | POST /apiv2/entry/INFOHASH -- modify an entry 23 | 24 | ===Collections=== 25 | POST /apiv2/collection -- create a collection 26 | POST /apiv2/collection/collection-name -- update a collection 27 | POST /apiv2/collection/collection-name/delete -- delete a collection 28 | POST /apiv2/collection/collection-name/add -- add an item to a collection 29 | POST /apiv2/collection/collection-name/remove -- remove an item from a collection 30 | 31 | ===Testing=== 32 | GET /apiv2/test -- test access rights 33 | ``` 34 | 35 | 36 | The API fields for uploading an entry to Academic Torrents are shown below. 37 | To upload a file you must send a POST request to https://academictorrents.com/apiv2/entry with the following parameters as well as your API Key. 38 | 39 | ``` 40 | name : "The title of the publication" 41 | authors : "Author1 and Author2" 42 | descr : "@article{, 43 | title = {The title of the publication}, 44 | author = {Author1 and Author2}, 45 | abstract = {Abstract} 46 | }" 47 | category : 6 48 | tags : "Tag1, Tag2" 49 | urllist : "http://someurltoafile.com/file.pdf, http://anothermirror.com/file.pdf" 50 | file: data:application/x-bittorrent;base64,ZDg6YW5ub3VuY2UzODp...vMRIjFFguASKUplZQ== 51 | ``` 52 | 53 | 54 | ## Curl Examples 55 | 56 | To use the above API Key you can use curl. Curl is a simple way of sending data the server just to test that our API is working. Below is the curl command to test your API key on our server. The -b option sets a cookie. We can use this to pass the API key and isolate it from the post data. 57 | The --data tag must be present to instruct curl that this is a POST request and not a GET request. 58 | 59 | ``` 60 | $ curl https://academictorrents.com/apiv2/test -b "uid=14;pass=71135221ceb8b5279cd15150d2126dcb" --data "" 61 | Welcome to the API test! 62 | You have made a POST request. 63 | API Key Received: uid=14&pass=71135221ceb8b5279cd15150d2126dcb 64 | Your username is joecohen 65 | Everything seems fine, You should be able to use the API 66 | ``` 67 | 68 | You can also put the API Key directly in the POST request via the --data argument 69 | 70 | ``` 71 | $ curl https://academictorrents.com/apiv2/test --data "uid=14&pass=71135221ceb8b5279cd15150d2126dcb" 72 | Welcome to the API test! 73 | You have made a POST request. 74 | API Key Received: uid=14&pass=71135221ceb8b5279cd15150d2126dcb 75 | Your username is joecohen 76 | Everything seems fine, You should be able to use the API 77 | ``` 78 | 79 | You can also put the API Key directly in the GET request. 80 | 81 | ``` 82 | $ curl https://academictorrents.com/apiv2/test?uid=14&pass=71135221ceb8b5279cd15150d2126dcb" 83 | Welcome to the API test! 84 | You have made a GET request. 85 | API Key Received: uid=14&pass=71135221ceb8b5279cd15150d2126dcb 86 | Your username is joecohen 87 | Everything seems fine, You should be able to use the API 88 | ``` 89 | 90 | ## Python Example 91 | 92 | This is a Python API usage example. A tool that uses this code is here: [https://github.com/academictorrents/academictorrents_uploader](https://github.com/academictorrents/academictorrents_uploader) 93 | 94 | ``` 95 | # get base64 of torrent 96 | f = open("file.torrent", 'rb') 97 | b64_torrent = b64encode(f.read()) 98 | f.close() 99 | 100 | post_params = { 101 | 'uid' : "14", 102 | 'pass' : "71135221ceb8b5279cd15150d2126dcb", 103 | 'name' : "The title of the publication", 104 | 'authors' : "Author1 and Author2", 105 | 'descr' : """@article{, 106 | title = {The title of the publication}, 107 | author = {Author1 and Author2}, 108 | abstract = {Abstract} 109 | }""", 110 | 'category' : "6", 111 | 'tags' : "tag1, tag2", 112 | 'urllist' : "http://domainname/backupfileurl.zip", 113 | 'file' : b64_torrent 114 | } 115 | 116 | data = urlencode(post_params).encode('utf-8') 117 | req = Request('https://academictorrents.com/apiv2/entry', data) 118 | 119 | response = urlopen(req) 120 | ``` 121 | 122 | 123 | 124 | 125 | -------------------------------------------------------------------------------- /docs/about.md: -------------------------------------------------------------------------------- 1 | # About 2 | 3 | Academic Torrents was established to meet the demands of science in the age of big data. 4 | It utilizes a scalable BitTorrent platform that distributes the burden of hosting data, 5 | eliminating the risk of data loss due to the rise and fall of dataset hosting providers. 6 | Researchers are empowered to replicate data they are working with and share large datasets 7 | without incurring the high costs usually associated with commercial providers. 8 | 9 | 10 | Academic Torrents is a product of the [Institute for Reproducible Research](https://reproducibilityinstitute.org/) (a U.S. 501(c)3 nonprofit). 11 | 12 | Twitter: [@academictorrent](https://twitter.com/academictorrent)
13 | Facebook: [AcademicTorrents](https://www.facebook.com/academictorrents/) 14 | 15 | ## Team 16 | 17 | 18 | | ![](_static/img/joe.jpg) | ![](_static/img/henry.jpg) | ![](_static/img/nogueira.jpg) | 19 | | :----: | :----: | :----: | 20 | | Joseph Paul Cohen |        Henry Z Lo        | Jonathan Nogueira | 21 | 22 | 23 | 24 | ## Mission 25 | 26 | Personal Statement 27 | 28 | + This service is designed to facilitate storage of all the data used in research, including datasets as well as publications. There are many advantages of using bittorrent technology to disseminate this work. 29 | 30 | + Distributed storage and content delivery provided by anyone. Files can be securely downloaded from other users of the system. They can share the file for a day or a year. 31 | + Mirroring the content can be done from a desktop computer anywhere. Everyone surrounding this computer will have local access to the data automatically and securely. 32 | + Bundles of files, not just papers, or any size can be disseminated in this way as long as at least one person can become a seed for that data. 33 | + Torrent technology allows a group of editors to "seed" their own peer-reviewed published articles with just a torrent client. Each editor can have part or all of the papers stored on their desktops and have a torrent tracker to coordinate the delivery of papers without a dedicated server. 34 | 35 | + One aim of this site is to create the infrastructure to allow open access journals to operate at low cost. By facilitating file transfers, the journal can focus on its core mission of providing world class research. After peer review the paper can be indexed on this site and disseminated throughout our system. 36 | 37 | + Large dataset delivery can be supported by researchers in the field that have the dataset on their machine. A popular large dataset doesn't need to be housed centrally. Researchers can have part of the dataset they are working on and they can help host it together. 38 | 39 | + Libraries can host this data to host papers from their own campus without becoming the only source of the data. So even if a library's system is broken other universities can participate in getting that data into the hands of researchers. 40 | 41 | -Joseph Paul Cohen 2013 42 | joseph /at/ josephpcohen.com 43 | 44 | 45 | 46 | ## Cite 47 | 48 | Please cite Academic Torrents: 49 | 50 | - Henry Z. Lo. and Cohen, Joseph Paul “Academic Torrents: Scalable Data Distribution.” Neural Information Processing Systems Challenges in Machine Learning (CiML) Workshop, 2016, http://arxiv.org/abs/1603.04395. 51 | 52 | - Cohen, Joseph Paul, and Henry Z. Lo. “Academic Torrents: A Community-Maintained Distributed Repository.” Annual Conference of the Extreme Science and Engineering Discovery Environment, 2014, http://doi.org/10.1145/2616498.2616528. 53 | 54 | [download bibtex file academictorrents.bib](https://academictorrents.com/academictorrents.bib) 55 | 56 | ``` 57 | @inproceedings{Cohen2014, 58 | title = {Academic Torrents: A Community-Maintained Distributed Repository}, 59 | author = {Cohen, Joseph Paul and Lo, Henry Z.}, 60 | booktitle = {Annual Conference of the Extreme Science and Engineering Discovery Environment}, 61 | doi = {10.1145/2616498.2616528}, 62 | url = {http://doi.acm.org/10.1145/2616498.2616528}, 63 | year = {2014} 64 | } 65 | 66 | @inproceedings{Lo2016, 67 | title = {Academic Torrents: Scalable Data Distribution}, 68 | author = {Lo, Henry Z. and Cohen, Joseph Paul}, 69 | booktitle = {Neural Information Processing Systems Challenges in Machine Learning (CiML) workshop}, 70 | arxivId = {1603.04395}, 71 | url = {http://arxiv.org/abs/1603.04395}, 72 | year = {2016} 73 | } 74 | ``` 75 | 76 | 77 | ## Support 78 | 79 | If you are having issues, please let us know 80 | We have an issue tracker here: [https://github.com/AcademicTorrents/academictorrents-docs/issues](https://github.com/AcademicTorrents/academictorrents-docs/issues) 81 | We have a contact email here: [contact@academictorrents.com](mailto:contact@academictorrents.com) 82 | 83 | 84 | 85 | ## Legal 86 | 87 | Please submit DMCA requests using this [Google form](https://docs.google.com/forms/d/1UZpffALavOF_X06QebmzbZZ7OyiGxjcn4vWhTQyHFPo/viewform) 88 | We have never received an order to turn over user information. 89 | 90 | View DMCA requests here: [https://academictorrents.com/dmca.php](https://academictorrents.com/dmca.php) 91 | 92 | ## Thanks 93 | 94 | ### Python at-python library 95 | 96 | - Martin Weiss 97 | 98 | ### Smart Node Team 2014 99 | 100 | - Jonathan Nogueira 101 | - Adrian Garay 102 | - Grigorii Lazari 103 | - James Lee 104 | - Luc Nguyen 105 | - Mani Jalilian 106 | - dward Grigoryan 107 | 108 | ### Java BitTorrent API Team 2015 109 | 110 | - Alpesh Kothari 111 | - Gregory McPherran 112 | 113 | ### Contributors 114 | 115 | - akmalhisyam 116 | - Mantas Radzevičius 117 | - Stefan Parviainen 118 | - Hanz Gumapac 119 | - Dennis Yassine 120 | - Khan Janny (@Reboot_ex) 121 | 122 | 123 | -------------------------------------------------------------------------------- /docs/Makefile: -------------------------------------------------------------------------------- 1 | # Makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line. 5 | SPHINXOPTS = 6 | SPHINXBUILD = sphinx-build 7 | PAPER = 8 | BUILDDIR = _build 9 | 10 | # User-friendly check for sphinx-build 11 | ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1) 12 | $(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) 13 | endif 14 | 15 | # Internal variables. 16 | PAPEROPT_a4 = -D latex_paper_size=a4 17 | PAPEROPT_letter = -D latex_paper_size=letter 18 | ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 19 | # the i18n builder cannot share the environment and doctrees with the others 20 | I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 21 | 22 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext 23 | 24 | help: 25 | @echo "Please use \`make ' where is one of" 26 | @echo " html to make standalone HTML files" 27 | @echo " dirhtml to make HTML files named index.html in directories" 28 | @echo " singlehtml to make a single large HTML file" 29 | @echo " pickle to make pickle files" 30 | @echo " json to make JSON files" 31 | @echo " htmlhelp to make HTML files and a HTML help project" 32 | @echo " qthelp to make HTML files and a qthelp project" 33 | @echo " devhelp to make HTML files and a Devhelp project" 34 | @echo " epub to make an epub" 35 | @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 36 | @echo " latexpdf to make LaTeX files and run them through pdflatex" 37 | @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" 38 | @echo " text to make text files" 39 | @echo " man to make manual pages" 40 | @echo " texinfo to make Texinfo files" 41 | @echo " info to make Texinfo files and run them through makeinfo" 42 | @echo " gettext to make PO message catalogs" 43 | @echo " changes to make an overview of all changed/added/deprecated items" 44 | @echo " xml to make Docutils-native XML files" 45 | @echo " pseudoxml to make pseudoxml-XML files for display purposes" 46 | @echo " linkcheck to check all external links for integrity" 47 | @echo " doctest to run all doctests embedded in the documentation (if enabled)" 48 | 49 | clean: 50 | rm -rf $(BUILDDIR)/* 51 | 52 | html: 53 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 54 | @echo 55 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 56 | 57 | dirhtml: 58 | $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 59 | @echo 60 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 61 | 62 | singlehtml: 63 | $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 64 | @echo 65 | @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 66 | 67 | pickle: 68 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 69 | @echo 70 | @echo "Build finished; now you can process the pickle files." 71 | 72 | json: 73 | $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 74 | @echo 75 | @echo "Build finished; now you can process the JSON files." 76 | 77 | htmlhelp: 78 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 79 | @echo 80 | @echo "Build finished; now you can run HTML Help Workshop with the" \ 81 | ".hhp project file in $(BUILDDIR)/htmlhelp." 82 | 83 | qthelp: 84 | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 85 | @echo 86 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 87 | ".qhcp project file in $(BUILDDIR)/qthelp, like this:" 88 | @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/ReadtheDocsTemplate.qhcp" 89 | @echo "To view the help file:" 90 | @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/ReadtheDocsTemplate.qhc" 91 | 92 | devhelp: 93 | $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 94 | @echo 95 | @echo "Build finished." 96 | @echo "To view the help file:" 97 | @echo "# mkdir -p $$HOME/.local/share/devhelp/ReadtheDocsTemplate" 98 | @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/ReadtheDocsTemplate" 99 | @echo "# devhelp" 100 | 101 | epub: 102 | $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 103 | @echo 104 | @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 105 | 106 | latex: 107 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 108 | @echo 109 | @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 110 | @echo "Run \`make' in that directory to run these through (pdf)latex" \ 111 | "(use \`make latexpdf' here to do that automatically)." 112 | 113 | latexpdf: 114 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 115 | @echo "Running LaTeX files through pdflatex..." 116 | $(MAKE) -C $(BUILDDIR)/latex all-pdf 117 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 118 | 119 | latexpdfja: 120 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 121 | @echo "Running LaTeX files through platex and dvipdfmx..." 122 | $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja 123 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 124 | 125 | text: 126 | $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 127 | @echo 128 | @echo "Build finished. The text files are in $(BUILDDIR)/text." 129 | 130 | man: 131 | $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 132 | @echo 133 | @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 134 | 135 | texinfo: 136 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 137 | @echo 138 | @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." 139 | @echo "Run \`make' in that directory to run these through makeinfo" \ 140 | "(use \`make info' here to do that automatically)." 141 | 142 | info: 143 | $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo 144 | @echo "Running Texinfo files through makeinfo..." 145 | make -C $(BUILDDIR)/texinfo info 146 | @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." 147 | 148 | gettext: 149 | $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale 150 | @echo 151 | @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." 152 | 153 | changes: 154 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 155 | @echo 156 | @echo "The overview file is in $(BUILDDIR)/changes." 157 | 158 | linkcheck: 159 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 160 | @echo 161 | @echo "Link check complete; look for any errors in the above output " \ 162 | "or in $(BUILDDIR)/linkcheck/output.txt." 163 | 164 | doctest: 165 | $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 166 | @echo "Testing of doctests in the sources finished, look at the " \ 167 | "results in $(BUILDDIR)/doctest/output.txt." 168 | 169 | xml: 170 | $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml 171 | @echo 172 | @echo "Build finished. The XML files are in $(BUILDDIR)/xml." 173 | 174 | pseudoxml: 175 | $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml 176 | @echo 177 | @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." 178 | -------------------------------------------------------------------------------- /docs/make.bat: -------------------------------------------------------------------------------- 1 | @ECHO OFF 2 | 3 | REM Command file for Sphinx documentation 4 | 5 | if "%SPHINXBUILD%" == "" ( 6 | set SPHINXBUILD=sphinx-build 7 | ) 8 | set BUILDDIR=_build 9 | set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . 10 | set I18NSPHINXOPTS=%SPHINXOPTS% . 11 | if NOT "%PAPER%" == "" ( 12 | set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS% 13 | set I18NSPHINXOPTS=-D latex_paper_size=%PAPER% %I18NSPHINXOPTS% 14 | ) 15 | 16 | if "%1" == "" goto help 17 | 18 | if "%1" == "help" ( 19 | :help 20 | echo.Please use `make ^` where ^ is one of 21 | echo. html to make standalone HTML files 22 | echo. dirhtml to make HTML files named index.html in directories 23 | echo. singlehtml to make a single large HTML file 24 | echo. pickle to make pickle files 25 | echo. json to make JSON files 26 | echo. htmlhelp to make HTML files and a HTML help project 27 | echo. qthelp to make HTML files and a qthelp project 28 | echo. devhelp to make HTML files and a Devhelp project 29 | echo. epub to make an epub 30 | echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter 31 | echo. text to make text files 32 | echo. man to make manual pages 33 | echo. texinfo to make Texinfo files 34 | echo. gettext to make PO message catalogs 35 | echo. changes to make an overview over all changed/added/deprecated items 36 | echo. xml to make Docutils-native XML files 37 | echo. pseudoxml to make pseudoxml-XML files for display purposes 38 | echo. linkcheck to check all external links for integrity 39 | echo. doctest to run all doctests embedded in the documentation if enabled 40 | goto end 41 | ) 42 | 43 | if "%1" == "clean" ( 44 | for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i 45 | del /q /s %BUILDDIR%\* 46 | goto end 47 | ) 48 | 49 | 50 | %SPHINXBUILD% 2> nul 51 | if errorlevel 9009 ( 52 | echo. 53 | echo.The 'sphinx-build' command was not found. Make sure you have Sphinx 54 | echo.installed, then set the SPHINXBUILD environment variable to point 55 | echo.to the full path of the 'sphinx-build' executable. Alternatively you 56 | echo.may add the Sphinx directory to PATH. 57 | echo. 58 | echo.If you don't have Sphinx installed, grab it from 59 | echo.http://sphinx-doc.org/ 60 | exit /b 1 61 | ) 62 | 63 | if "%1" == "html" ( 64 | %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html 65 | if errorlevel 1 exit /b 1 66 | echo. 67 | echo.Build finished. The HTML pages are in %BUILDDIR%/html. 68 | goto end 69 | ) 70 | 71 | if "%1" == "dirhtml" ( 72 | %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml 73 | if errorlevel 1 exit /b 1 74 | echo. 75 | echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml. 76 | goto end 77 | ) 78 | 79 | if "%1" == "singlehtml" ( 80 | %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml 81 | if errorlevel 1 exit /b 1 82 | echo. 83 | echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml. 84 | goto end 85 | ) 86 | 87 | if "%1" == "pickle" ( 88 | %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle 89 | if errorlevel 1 exit /b 1 90 | echo. 91 | echo.Build finished; now you can process the pickle files. 92 | goto end 93 | ) 94 | 95 | if "%1" == "json" ( 96 | %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json 97 | if errorlevel 1 exit /b 1 98 | echo. 99 | echo.Build finished; now you can process the JSON files. 100 | goto end 101 | ) 102 | 103 | if "%1" == "htmlhelp" ( 104 | %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp 105 | if errorlevel 1 exit /b 1 106 | echo. 107 | echo.Build finished; now you can run HTML Help Workshop with the ^ 108 | .hhp project file in %BUILDDIR%/htmlhelp. 109 | goto end 110 | ) 111 | 112 | if "%1" == "qthelp" ( 113 | %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp 114 | if errorlevel 1 exit /b 1 115 | echo. 116 | echo.Build finished; now you can run "qcollectiongenerator" with the ^ 117 | .qhcp project file in %BUILDDIR%/qthelp, like this: 118 | echo.^> qcollectiongenerator %BUILDDIR%\qthelp\complexity.qhcp 119 | echo.To view the help file: 120 | echo.^> assistant -collectionFile %BUILDDIR%\qthelp\complexity.ghc 121 | goto end 122 | ) 123 | 124 | if "%1" == "devhelp" ( 125 | %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp 126 | if errorlevel 1 exit /b 1 127 | echo. 128 | echo.Build finished. 129 | goto end 130 | ) 131 | 132 | if "%1" == "epub" ( 133 | %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub 134 | if errorlevel 1 exit /b 1 135 | echo. 136 | echo.Build finished. The epub file is in %BUILDDIR%/epub. 137 | goto end 138 | ) 139 | 140 | if "%1" == "latex" ( 141 | %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex 142 | if errorlevel 1 exit /b 1 143 | echo. 144 | echo.Build finished; the LaTeX files are in %BUILDDIR%/latex. 145 | goto end 146 | ) 147 | 148 | if "%1" == "latexpdf" ( 149 | %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex 150 | cd %BUILDDIR%/latex 151 | make all-pdf 152 | cd %BUILDDIR%/.. 153 | echo. 154 | echo.Build finished; the PDF files are in %BUILDDIR%/latex. 155 | goto end 156 | ) 157 | 158 | if "%1" == "latexpdfja" ( 159 | %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex 160 | cd %BUILDDIR%/latex 161 | make all-pdf-ja 162 | cd %BUILDDIR%/.. 163 | echo. 164 | echo.Build finished; the PDF files are in %BUILDDIR%/latex. 165 | goto end 166 | ) 167 | 168 | if "%1" == "text" ( 169 | %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text 170 | if errorlevel 1 exit /b 1 171 | echo. 172 | echo.Build finished. The text files are in %BUILDDIR%/text. 173 | goto end 174 | ) 175 | 176 | if "%1" == "man" ( 177 | %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man 178 | if errorlevel 1 exit /b 1 179 | echo. 180 | echo.Build finished. The manual pages are in %BUILDDIR%/man. 181 | goto end 182 | ) 183 | 184 | if "%1" == "texinfo" ( 185 | %SPHINXBUILD% -b texinfo %ALLSPHINXOPTS% %BUILDDIR%/texinfo 186 | if errorlevel 1 exit /b 1 187 | echo. 188 | echo.Build finished. The Texinfo files are in %BUILDDIR%/texinfo. 189 | goto end 190 | ) 191 | 192 | if "%1" == "gettext" ( 193 | %SPHINXBUILD% -b gettext %I18NSPHINXOPTS% %BUILDDIR%/locale 194 | if errorlevel 1 exit /b 1 195 | echo. 196 | echo.Build finished. The message catalogs are in %BUILDDIR%/locale. 197 | goto end 198 | ) 199 | 200 | if "%1" == "changes" ( 201 | %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes 202 | if errorlevel 1 exit /b 1 203 | echo. 204 | echo.The overview file is in %BUILDDIR%/changes. 205 | goto end 206 | ) 207 | 208 | if "%1" == "linkcheck" ( 209 | %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck 210 | if errorlevel 1 exit /b 1 211 | echo. 212 | echo.Link check complete; look for any errors in the above output ^ 213 | or in %BUILDDIR%/linkcheck/output.txt. 214 | goto end 215 | ) 216 | 217 | if "%1" == "doctest" ( 218 | %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest 219 | if errorlevel 1 exit /b 1 220 | echo. 221 | echo.Testing of doctests in the sources finished, look at the ^ 222 | results in %BUILDDIR%/doctest/output.txt. 223 | goto end 224 | ) 225 | 226 | if "%1" == "xml" ( 227 | %SPHINXBUILD% -b xml %ALLSPHINXOPTS% %BUILDDIR%/xml 228 | if errorlevel 1 exit /b 1 229 | echo. 230 | echo.Build finished. The XML files are in %BUILDDIR%/xml. 231 | goto end 232 | ) 233 | 234 | if "%1" == "pseudoxml" ( 235 | %SPHINXBUILD% -b pseudoxml %ALLSPHINXOPTS% %BUILDDIR%/pseudoxml 236 | if errorlevel 1 exit /b 1 237 | echo. 238 | echo.Build finished. The pseudo-XML files are in %BUILDDIR%/pseudoxml. 239 | goto end 240 | ) 241 | 242 | :end 243 | -------------------------------------------------------------------------------- /docs/getting-started.md: -------------------------------------------------------------------------------- 1 | # Getting Started 2 | 3 | Welcome to Academic Torrents! This guide will help you understand the basics of using our platform for sharing and downloading academic datasets. 4 | 5 | ## What is Academic Torrents? 6 | 7 | Academic Torrents is a distributed system for sharing large academic datasets using BitTorrent technology. Unlike traditional file hosting services, Academic Torrents distributes the burden of hosting data across a network of users, making it more resilient and cost-effective for researchers. 8 | 9 | ## Key Concepts 10 | 11 | ### INFOHASH 12 | A unique 40-character hexadecimal identifier for each torrent file. It's calculated from the torrent's metadata and serves as a permanent, unique reference to that specific dataset. You can find the infohash in the torrent's details page URL or by examining the torrent file itself. 13 | 14 | ### Torrent File 15 | A small metadata file (usually with a `.torrent` extension) that contains information about the dataset, including file names, sizes, and the tracker information needed to download the data. 16 | 17 | ### Seeding 18 | The process of sharing data you have downloaded with other users. When you seed a torrent, you become part of the distribution network, helping others download the dataset faster. 19 | 20 | ### Tracker 21 | A server that coordinates the distribution of data between users. Academic Torrents operates its own tracker to manage the sharing of academic datasets. 22 | 23 | ### Magnet Link 24 | A URI that contains the infohash and tracker information, allowing you to download a torrent without first downloading a `.torrent` file. 25 | 26 | ### Peers and Swarm 27 | - **Peer**: Any user participating in downloading or uploading a torrent 28 | - **Swarm**: The collective group of all peers sharing a particular torrent 29 | - **Leecher**: A peer that is downloading but not yet sharing the complete file 30 | - **Seeder**: A peer that has the complete file and is sharing it with others 31 | 32 | ### Backup URLs (WebSeeds) 33 | HTTP URLs that provide alternative download sources when BitTorrent peers are unavailable. These bypass firewalls and provide fallback access to datasets. 34 | 35 | ## Why Use Academic Torrents? 36 | 37 | ### Benefits for Researchers 38 | - **Cost-effective**: No expensive cloud storage fees for large datasets 39 | - **Resilient**: Data remains available even if original hosts go offline 40 | - **Fast downloads**: Multiple sources provide faster download speeds 41 | - **Permanent access**: Datasets won't disappear due to hosting changes 42 | - **Version control**: Each version gets a unique identifier 43 | - **Global distribution**: Data automatically spreads to researchers worldwide 44 | 45 | ### Benefits for Institutions 46 | - **Reduced bandwidth costs**: Distribute hosting load across the community 47 | - **Compliance friendly**: Maintain control over your data while sharing it 48 | - **Academic focus**: Platform designed specifically for research needs 49 | - **Long-term preservation**: Community-driven data preservation 50 | 51 | ## System Requirements 52 | 53 | ### For Downloading 54 | - **Operating System**: Windows, macOS, or Linux 55 | - **BitTorrent Client**: We recommend Transmission (free, open-source) 56 | - **Internet Connection**: Broadband recommended for large datasets 57 | - **Storage Space**: Enough free space for the datasets you want to download 58 | 59 | ### For Uploading/Seeding 60 | - **Stable Internet**: Reliable connection for consistent sharing 61 | - **Open Ports**: Some routers may need port forwarding configuration 62 | - **Adequate Bandwidth**: Consider your upload limits when seeding multiple datasets 63 | 64 | ## Choosing the Right BitTorrent Client 65 | 66 | ### Recommended: Transmission 67 | - **Free and open-source** 68 | - **Available on all platforms** 69 | - **Simple, clean interface** 70 | - **Low resource usage** 71 | - **Excellent for academic use** 72 | - **Download**: [transmissionbt.com](https://www.transmissionbt.com/) 73 | 74 | ### Alternative Clients 75 | - **qBittorrent**: Feature-rich, open-source alternative 76 | - **Deluge**: Lightweight, plugin-extensible client 77 | - **rtorrent**: Command-line client for servers 78 | 79 | ## Quick Start 80 | 81 | ### For Downloading Data 82 | 1. **Browse datasets** at [academictorrents.com](https://academictorrents.com) 83 | 2. **Install a BitTorrent client** (we recommend [Transmission](https://www.transmissionbt.com/)) 84 | 3. **Find a dataset** you need using the search function 85 | 4. **Download the torrent** by clicking the "Download" button or copying the magnet link 86 | 5. **Open in your client** by double-clicking the `.torrent` file or pasting the magnet link 87 | 6. **Choose download location** and start the download 88 | 7. **Keep seeding** after download to help others access the data 89 | 90 | ### For Sharing Data 91 | 1. **Create an account** at [academictorrents.com](https://academictorrents.com) 92 | 2. **Prepare your dataset** - organize files and create documentation 93 | 3. **Create a torrent file** using your BitTorrent client 94 | 4. **Upload your torrent** using the [upload form](https://academictorrents.com/upload.php) 95 | 5. **Fill in metadata** - title, description, category, tags 96 | 6. **Start seeding** to make your data available 97 | 7. **Monitor and maintain** your uploads over time 98 | 99 | ## Step-by-Step: Your First Download 100 | 101 | ### Step 1: Install Transmission 102 | 1. Visit [transmissionbt.com](https://www.transmissionbt.com/) 103 | 2. Download the version for your operating system 104 | 3. Install following the standard process for your OS 105 | 4. Launch Transmission 106 | 107 | ### Step 2: Find a Dataset 108 | 1. Go to [academictorrents.com](https://academictorrents.com) 109 | 2. Use the search bar or browse categories 110 | 3. Click on a dataset that interests you 111 | 4. Read the description and check the file size 112 | 113 | ### Step 3: Download the Torrent 114 | **Option A: Torrent File** 115 | 1. Click the "Download" button 116 | 2. Save the `.torrent` file to your computer 117 | 3. Double-click the file to open in Transmission 118 | 119 | **Option B: Magnet Link** 120 | 1. Right-click the magnet link 121 | 2. Copy the link address 122 | 3. In Transmission: File → Open URL → Paste the link 123 | 124 | ### Step 4: Configure Download 125 | 1. Choose where to save the files 126 | 2. Select which files to download (if it's a multi-file torrent) 127 | 3. Set bandwidth limits if needed 128 | 4. Click "Add" to start downloading 129 | 130 | ### Step 5: Monitor Progress 131 | 1. Watch the download progress in Transmission 132 | 2. Check download speed and peers connected 133 | 3. Be patient - large datasets may take time 134 | 4. Leave Transmission running to continue downloading 135 | 136 | ## Common Issues and Solutions 137 | 138 | ### Slow Downloads 139 | - **Check peers**: Look for torrents with more seeders 140 | - **Port forwarding**: Configure your router for better connectivity 141 | - **Bandwidth limits**: Remove or increase download limits 142 | - **Peak hours**: Try downloading during off-peak times 143 | 144 | ### Can't Connect to Tracker 145 | - **Firewall**: Check if your firewall is blocking Transmission 146 | - **ISP blocking**: Some ISPs block BitTorrent traffic 147 | - **Proxy settings**: Configure proxy if required by your network 148 | - **Try magnet links**: Sometimes work when tracker URLs don't 149 | 150 | ### Files Won't Start Downloading 151 | - **Check file availability**: Ensure there are active seeders 152 | - **Restart client**: Sometimes helps refresh connections 153 | - **Re-add torrent**: Delete and re-add the torrent 154 | - **Check disk space**: Ensure you have enough free space 155 | 156 | 157 | ## Next Steps 158 | 159 | ### Learn More About the Platform 160 | - **[About Academic Torrents](about.md)**: Learn about our mission and team 161 | - **[BitTorrent Technology](bittorrent.md)**: Understand the underlying technology 162 | - **[FAQ](faq.md)**: Find answers to common questions 163 | 164 | ### Start Using Academic Torrents 165 | - **[Downloading Guide](downloading.md)**: Detailed instructions for downloading datasets 166 | - **[Uploading Guide](uploading.md)**: Complete guide to sharing your research data 167 | - **[API Documentation](api.md)**: Programmatic access to Academic Torrents 168 | - **[Searching](searching.md)**: Advanced techniques for finding datasets 169 | 170 | ### Join the Community 171 | - **[Mirroring](mirroring.md)**: Help host data and support the community 172 | - **Contributing**: Share your datasets and help others 173 | - **Feedback**: Let us know how we can improve the platform 174 | -------------------------------------------------------------------------------- /docs/conf.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # Read the Docs Template documentation build configuration file, created by 4 | # sphinx-quickstart on Tue Aug 26 14:19:49 2014. 5 | # 6 | # This file is execfile()d with the current directory set to its 7 | # containing dir. 8 | # 9 | # Note that not all possible configuration values are present in this 10 | # autogenerated file. 11 | # 12 | # All configuration values have a default; values that are commented out 13 | # serve to show the default. 14 | 15 | import sys 16 | import os 17 | 18 | # If extensions (or modules to document with autodoc) are in another directory, 19 | # add these directories to sys.path here. If the directory is relative to the 20 | # documentation root, use os.path.abspath to make it absolute, like shown here. 21 | #sys.path.insert(0, os.path.abspath('.')) 22 | 23 | # -- General configuration ------------------------------------------------ 24 | 25 | # If your documentation needs a minimal Sphinx version, state it here. 26 | #needs_sphinx = '1.0' 27 | 28 | # Add any Sphinx extension module names here, as strings. They can be 29 | # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 30 | # ones. 31 | extensions = ['recommonmark', 'sphinx_markdown_tables'] 32 | 33 | # Add any paths that contain templates here, relative to this directory. 34 | templates_path = ['_templates'] 35 | 36 | # The suffix of source filenames. 37 | source_suffix = '.rst' 38 | 39 | # The encoding of source files. 40 | #source_encoding = 'utf-8-sig' 41 | 42 | # The master toctree document. 43 | master_doc = 'index' 44 | 45 | # General information about the project. 46 | project = u'Academic Torrents Documentation' 47 | copyright = u'2022, Academic Torrents' 48 | 49 | # The version info for the project you're documenting, acts as replacement for 50 | # |version| and |release|, also used in various other places throughout the 51 | # built documents. 52 | # 53 | # The short X.Y version. 54 | version = '1.0' 55 | # The full version, including alpha/beta/rc tags. 56 | release = '1.0' 57 | 58 | # The language for content autogenerated by Sphinx. Refer to documentation 59 | # for a list of supported languages. 60 | #language = None 61 | 62 | # There are two options for replacing |today|: either, you set today to some 63 | # non-false value, then it is used: 64 | #today = '' 65 | # Else, today_fmt is used as the format for a strftime call. 66 | #today_fmt = '%B %d, %Y' 67 | 68 | # List of patterns, relative to source directory, that match files and 69 | # directories to ignore when looking for source files. 70 | exclude_patterns = ['_build'] 71 | 72 | # The reST default role (used for this markup: `text`) to use for all 73 | # documents. 74 | #default_role = None 75 | 76 | # If true, '()' will be appended to :func: etc. cross-reference text. 77 | #add_function_parentheses = True 78 | 79 | # If true, the current module name will be prepended to all description 80 | # unit titles (such as .. function::). 81 | #add_module_names = True 82 | 83 | # If true, sectionauthor and moduleauthor directives will be shown in the 84 | # output. They are ignored by default. 85 | #show_authors = False 86 | 87 | # The name of the Pygments (syntax highlighting) style to use. 88 | pygments_style = 'sphinx' 89 | 90 | # A list of ignored prefixes for module index sorting. 91 | #modindex_common_prefix = [] 92 | 93 | # If true, keep warnings as "system message" paragraphs in the built documents. 94 | #keep_warnings = False 95 | 96 | 97 | # -- Options for HTML output ---------------------------------------------- 98 | 99 | # The theme to use for HTML and HTML Help pages. See the documentation for 100 | # a list of builtin themes. 101 | html_theme = 'sphinx_rtd_theme' 102 | 103 | # Theme options are theme-specific and customize the look and feel of a theme 104 | # further. For a list of options available for each theme, see the 105 | # documentation. 106 | #html_theme_options = {} 107 | 108 | # Add any paths that contain custom themes here, relative to this directory. 109 | #html_theme_path = [] 110 | 111 | # The name for this set of Sphinx documents. If None, it defaults to 112 | # " v documentation". 113 | #html_title = None 114 | 115 | # A shorter title for the navigation bar. Default is the same as html_title. 116 | #html_short_title = None 117 | 118 | # The name of an image file (relative to this directory) to place at the top 119 | # of the sidebar. 120 | html_logo = "at-logo.png" 121 | 122 | # The name of an image file (within the static path) to use as favicon of the 123 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 124 | # pixels large. 125 | #html_favicon = None 126 | 127 | # Add any paths that contain custom static files (such as style sheets) here, 128 | # relative to this directory. They are copied after the builtin static files, 129 | # so a file named "default.css" will overwrite the builtin "default.css". 130 | html_static_path = ['_static'] 131 | 132 | # Add any extra paths that contain custom files (such as robots.txt or 133 | # .htaccess) here, relative to this directory. These files are copied 134 | # directly to the root of the documentation. 135 | #html_extra_path = [] 136 | 137 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 138 | # using the given strftime format. 139 | #html_last_updated_fmt = '%b %d, %Y' 140 | 141 | # If true, SmartyPants will be used to convert quotes and dashes to 142 | # typographically correct entities. 143 | #html_use_smartypants = True 144 | 145 | # Custom sidebar templates, maps document names to template names. 146 | #html_sidebars = {} 147 | 148 | # Additional templates that should be rendered to pages, maps page names to 149 | # template names. 150 | #html_additional_pages = {} 151 | 152 | # If false, no module index is generated. 153 | #html_domain_indices = True 154 | 155 | # If false, no index is generated. 156 | #html_use_index = True 157 | 158 | # If true, the index is split into individual pages for each letter. 159 | #html_split_index = False 160 | 161 | # If true, links to the reST sources are added to the pages. 162 | #html_show_sourcelink = True 163 | 164 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 165 | #html_show_sphinx = True 166 | 167 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 168 | #html_show_copyright = True 169 | 170 | # If true, an OpenSearch description file will be output, and all pages will 171 | # contain a tag referring to it. The value of this option must be the 172 | # base URL from which the finished HTML is served. 173 | #html_use_opensearch = '' 174 | 175 | # This is the file name suffix for HTML files (e.g. ".xhtml"). 176 | #html_file_suffix = None 177 | 178 | # Output file base name for HTML help builder. 179 | htmlhelp_basename = 'academictorrentsdoc' 180 | 181 | 182 | # -- Options for LaTeX output --------------------------------------------- 183 | 184 | latex_elements = { 185 | # The paper size ('letterpaper' or 'a4paper'). 186 | #'papersize': 'letterpaper', 187 | 188 | # The font size ('10pt', '11pt' or '12pt'). 189 | #'pointsize': '10pt', 190 | 191 | # Additional stuff for the LaTeX preamble. 192 | #'preamble': '', 193 | } 194 | 195 | # Grouping the document tree into LaTeX files. List of tuples 196 | # (source start file, target name, title, 197 | # author, documentclass [howto, manual, or own class]). 198 | latex_documents = [ 199 | ('index', 'academictorrents.tex', u'Academic Torrents Documentation', 200 | u'Academic Torrents', 'manual'), 201 | ] 202 | 203 | # The name of an image file (relative to this directory) to place at the top of 204 | # the title page. 205 | #latex_logo = None 206 | 207 | # For "manual" documents, if this is true, then toplevel headings are parts, 208 | # not chapters. 209 | #latex_use_parts = False 210 | 211 | # If true, show page references after internal links. 212 | #latex_show_pagerefs = False 213 | 214 | # If true, show URL addresses after external links. 215 | #latex_show_urls = False 216 | 217 | # Documents to append as an appendix to all manuals. 218 | #latex_appendices = [] 219 | 220 | # If false, no module index is generated. 221 | #latex_domain_indices = True 222 | 223 | 224 | # -- Options for manual page output --------------------------------------- 225 | 226 | # One entry per manual page. List of tuples 227 | # (source start file, name, description, authors, manual section). 228 | man_pages = [ 229 | ('index', 'academictorrents', u'Academic Torrents Documentation', 230 | [u'c'], 1) 231 | ] 232 | 233 | # If true, show URL addresses after external links. 234 | #man_show_urls = False 235 | 236 | 237 | # -- Options for Texinfo output ------------------------------------------- 238 | 239 | # Grouping the document tree into Texinfo files. List of tuples 240 | # (source start file, target name, title, author, 241 | # dir menu entry, description, category) 242 | texinfo_documents = [ 243 | ('index', 'academictorrents', u'Academic Torrents Documentation', 244 | u'academictorrents', 'academictorrents', 'One line description of project.', 245 | 'Miscellaneous'), 246 | ] 247 | 248 | # Documents to append as an appendix to all manuals. 249 | #texinfo_appendices = [] 250 | 251 | # If false, no module index is generated. 252 | #texinfo_domain_indices = True 253 | 254 | # How to display URL addresses: 'footnote', 'no', or 'inline'. 255 | #texinfo_show_urls = 'footnote' 256 | 257 | # If true, do not generate a @detailmenu in the "Top" node's menu. 258 | #texinfo_no_detailmenu = False 259 | 260 | html_js_files = [ 261 | 'js/custom.js', 262 | ] 263 | 264 | html_theme_options = { 265 | 'analytics_id': 'UA-46214407-1', 266 | 'analytics_anonymize_ip': False, 267 | 'logo_only': True, 268 | 'display_version': True, 269 | 'prev_next_buttons_location': 'bottom', 270 | 'style_external_links': False, 271 | 'vcs_pageview_mode': '', 272 | 'style_nav_header_background': '#fcfcfc', 273 | # Toc options 274 | 'collapse_navigation': False, 275 | 'sticky_navigation': True, 276 | 'navigation_depth': 4, 277 | 'includehidden': True, 278 | 'titles_only': False 279 | 280 | } 281 | 282 | html_context = { 283 | "display_github": True, 284 | "github_user": "academictorrents", # Username 285 | "github_repo": "academictorrents-docs", # Repo name 286 | "github_version": "main", # Version 287 | "conf_py_path": "/docs/", # Path in the checkout to the docs root 288 | "last_updated": True, 289 | #"commit": False, 290 | } 291 | --------------------------------------------------------------------------------